click2mail_get_credit
Get account credit
The prepaid credit balance of the Click2Mail account (`balance`) and whether the balance may go negative (`allowNegative`). Check it before submitting a job paid with User Credit. GET /molpro/credit.
Takes no parameters.
click2mail_list_return_addresses
List saved account addresses
The addresses of one type saved on the account (return addresses, billing, business reply, courtesy reply, EDDM mailer addresses) with their ids; use an id as `return_address_id` when creating a job. GET /molpro/account/addresses.
Parametersaddress_typerequired
click2mail_get_product_options
Get product options
The mail products and valid option combinations (document class, layout, production time, envelope, color, paper, print option, mail class) for the account. Use the exact strings from this reply in click2mail_create_job and click2mail_estimate_cost. GET /molpro/productOptions.
Parametersdocument_classskip_bulk_print
click2mail_estimate_cost
Estimate mailing cost
Estimate the cost of a mailing from its print options and quantity without creating anything (nothing is charged). Use the exact option strings from click2mail_get_product_options. GET /molpro/costEstimate.
Parameterscolorrequiredlayoutrequiredenvelopequantityrequiredmail_classrequiredpaper_typerequiredpayment_typeprint_optionrequireddocument_classrequirednumber_of_pagesproduction_timerequirednon_standard_quantity+1 more
click2mail_list_documents
List documents
List the documents uploaded to the account (id, name, class, pages), most recent first. Use a document id when creating a job. GET /molpro/documents.
Parametersoffsetdocument_classnumber_of_documents
click2mail_get_address_list
Get address list status
Status of an uploaded address list: processing state (3 = CASS-standardized and ready for a job), name and counts. GET /molpro/addressLists/{id}.
Parametersaddress_list_idrequired
click2mail_get_address_list_info
Get address list details
Details of an address list: its addresses with the standardization result of each. Click2Mail returns 10 addresses by default: page with limit and offset. GET /molpro/addressLists/info.
Parameterslimitoffsetaddress_list_idrequired
click2mail_check_addresses
Check and correct addresses
Validate and standardize up to 100 US postal addresses (USPS/CASS correction) before mailing. Read-only: nothing is saved or sent. POST /molpro/addressCorrection.
Parametersaddressesrequired
click2mail_create_address_list
Create address list
WRITE: upload a recipient address list (up to 500 addresses) to the account. The list is standardized (CASS) by Click2Mail; poll click2mail_get_address_list until status 3, then use its id in click2mail_create_job. Creates data only; nothing is mailed or charged. POST /molpro/addressLists.
Parametersnamerequiredaddressesrequired
click2mail_upload_document_from_url
Upload document from URL
WRITE: have Click2Mail fetch a PDF (or other supported file) from a public http(s) URL and store it as a document on the account. Returns the document id for click2mail_create_job. Creates data only; nothing is mailed or charged. POST /molpro/documents/url.
Parametersurlrequireddocument_namerequireddocument_classdocument_format
click2mail_list_projects
List projects
List the account's projects (jobs are grouped by project; jobs without one are grouped by month, e.g. "March 2022"), most recently updated first. Use a project name with click2mail_list_project_jobs. GET /molpro/projects.
Parametersoffsetnumber_of_projects
click2mail_list_project_jobs
List jobs in a project
List the mailing jobs of one project (id, status, description). This is how to see the account's jobs: pick a project from click2mail_list_projects. GET /molpro/projects/jobs.
Parametersoffsetproject_namerequirednumber_of_jobs
click2mail_list_jobs_by_app_signature
List jobs by app signature
List the jobs that were created with a given `appSignature` (the label an integration puts on its jobs; click2mail_create_job sets it). GET /molpro/jobs/appSignature.
Parametersoffsetapp_signaturerequirednumber_of_jobsignore_tracking_data
click2mail_get_job_status
Get job status
Status of a job: numeric `status` and its `description` (for example 9 = Editing) plus the status URL. GET /molpro/jobs/{id}.
Parametersjob_idrequired
click2mail_get_job_info
Get job details
Full details of a job: print options, document, address list, dates, cost and payment. GET /molpro/jobs/info/{id}.
Parametersjob_idrequired
click2mail_get_job_tracking
Get job tracking
USPS tracking for a submitted job: per mail piece barcode, address, status, date and location. Tracking updates once a day, so one call per day is enough; nothing is tracked on staging. GET /molpro/jobs/{id}/tracking.
Parametersjob_idrequiredbar_codetracking_typetracking_detail
click2mail_get_job_cost
Get job cost
The exact cost of a created job (postage, printing, fees) for a payment type. Read it before click2mail_submit_job. GET /molpro/jobs/{id}/cost.
Parametersjob_idrequireddetailscoupon_codepayment_type
click2mail_create_job
Create job (draft)
WRITE: create a mailing job from an uploaded document and an address list. The job stays a draft (status Editing): nothing is printed, mailed or charged until click2mail_submit_job. Use the exact option strings from click2mail_get_product_options. Returns the job id. POST /molpro/jobs.
Parameterscolorrequiredlayoutrequiredenvelopemail_classrequiredpaper_typerequiredproject_iddocument_idrequiredendorsementmailing_dateprint_optionrequiredapp_signaturedocument_classrequired+3 more
click2mail_request_job_proof
Request job proof
WRITE: ask Click2Mail to render a proof (preview PDF) of a draft job. Free; nothing is mailed or charged. The reply names the proof; it takes a moment to render. POST /molpro/jobs/{id}/proof.
Parametersjob_idrequired
click2mail_submit_job
Submit job (spends money)
WRITE, SPENDS MONEY, NOT REVERSIBLE: submit a draft job for printing and USPS mailing. This charges postage and printing to the account (User Credit = prepaid balance, or Invoice) and the physical mail is sent to every recipient. Before calling: read click2mail_get_job_cost and click2mail_get_credit, and get the user's explicit go-ahead for this job and amount. `confirm` must be true. Cancellation is only possible for Invoice jobs, before processing starts. POST /molpro/jobs/{id}/submit.
Parametersjob_idrequiredconfirmrequiredbilling_typerequired
click2mail_cancel_job
Cancel submitted job
WRITE: cancel a SUBMITTED job. The vendor documents this only for jobs paid by invoice and only before processing for mailing has started; otherwise it fails. The mailing is stopped for good, so get the user's explicit go-ahead first; `confirm` must be true. To remove a draft use click2mail_delete_job. POST /molpro/jobs/{id}/cancel.
Parametersjob_idrequiredconfirmrequired
click2mail_delete_job
Delete draft job
WRITE: delete a job that has not been submitted (status Editing or PendingProofAcceptence). Submitted jobs cannot be deleted; use click2mail_cancel_job. POST /molpro/jobs/{id}/delete.
Parametersjob_idrequired