-
Address Correction - dealing with unmailable addresses.You can use the POST /addressCorrection API to check your address list. This API will return each address in your list with 3 boolean flags: standard, international & nonmailable. You can use this to filter out the nonMailable addresses. If you don't, our system will detect them and filter them out so that no production/postage cost is incurred on these addresses. Non-standard addresses will be printed and mailed at first class postage rate.
-
JSONWe currently do not officially support JSON. While most of our APIs do return JSON correctly, some are not yet JSON ready. So JSON is not reliable at this time.
-
524 - Timeout Error524 is a 100 sec timeout error. These errors are typically transient. If you continue to receive them on a regular basis or for a large period of time, contact our support team at 866-665-2787 or support@click2mail.com. Our hours of operation are Monday - Friday, 9 AM - 8 PM Eastern.
-
http://mailingonline.click2mail.com/molapi.asmxhttp://mailingonline.click2mail.com/molapi.asmx was an MOL Classic link that has been decommissioned.
-
Rest API Return CodesPOST /addressLists HTTP 200 status: 0, description: Uploaded / Created status: 1, description: Mapped status: 3, description: CASS Standardized → this status means address list is ready for use in jobs status: 9, description: Error HTTP 400 status: 9, description: Invalid input data. HTTP 500 status: 9, description: custom error message related to server error POST /documents HTTP 200 status: 0, description: Success HTTP 400 status 9, description: One of the required parameters is missing.
-
Monitoring API Status - BatchWe do not have a formal health check API call. There are two suggested ways of achieving this. The very first batch call you make: https://batch.click2mail.com/v1/batches can serve as your health check. If it returns successfully, then the service is up and running correctly. If your monitoring software is separate from code base that calls the batch APIs, we recommend the following call as your health-check: GET https://batch.click2mail.com/v1/batches/<batch-id>. The GET call returns the status of the batch-id you specify.
-
Reporting ProblemsWhen you need to report issues to api_support@click2mail.com, it is helpful to include as much of the following as possible: catch the HTTP error code you are receiving response message timestamp XML/PDF that you were uploading
-
Count standard, international, unmailable addresses.If you want just a count of the standard, international and non-mailable addresses, you can use GET /addressLists/{{addressListId}}.
-
Relevant Job Statuses - REST API UserAs a REST API consumer, the job status relevant to you are: 1. EDITING -- this is the status when you create a job via /molpro/jobs API 2. ORDER_SUBMITTED, ORDER_PROCESSING,AWAITING_PRODUCTION -- this is the status after you call /molpro/jobs/submit. Typically you get AWAITING_PRODUCTION but if the server is busy, it might take a few seconds for the status to go from ORDER_SUBMITTED -> ORDER_PROCESSING -> AWAITING_PRODUCTION 3. IN_PRODUCTION -- this is the status sometime after 8 PM EST when the job is sent to the printer.
-
504 - Gateway Timeout504 errors almost certainly mean we are having a problem. We are probably aware of the problem and and working on it. You can contact 866-665-2787 or support@click2mail.com to confirm. Support is available Monday - Friday, 9 am - 8 pm Eastern.
-
Download proofYou can also download the proof from the API call POST /jobs/<id>/proof.
-
Getting the ProofGetting proof is a 2-step process. Generate the proof on the server: You call the API https://rest.click2mail.com/molpro/jobs/{{jobId}}/proof -- This will return you the proofID and a URL to download the proof Download the proof PDF You can do this by calling the URL returned by the above call. This is a secure URL and works without giving credentials. It is used to display the proof to the user in their browser.