Click2Mail REST API

What authentication does the Click2Mail REST API use?

Click2Mail uses HTTP Basic authentication against rest.click2mail.com/molpro. You pass your username and password via the standard Authorization header. Through Jentic, those credentials are stored in your Jentic One instance and never exposed to the agent context.

Can I send a physical letter end-to-end with this API?

Yes. Upload a PDF to POST /documents, create recipients via POST /addressLists, bind them with POST /jobs, then call POST /jobs/{id}/submit. Click2Mail handles printing, addressing, and USPS dispatch from there.

Can I check my account balance before submitting jobs?

Yes. GET /account/credits returns the remaining credit balance, which is the right pre-check before a bulk /jobs/{id}/submit call to avoid mid-batch failures.

What are the rate limits for the Click2Mail REST API?

Click2Mail does not document fixed numeric rate limits in the public spec. In practice, document uploads are the slowest call (multipart payloads up to several MB), so cap concurrency to a handful of parallel uploads per account.

How do I send a letter through Jentic?

Run pip install jentic, search for 'send a physical letter via click2mail', load the document upload, address list create, job create, and job submit operations in sequence, and execute them. Jentic handles the Basic auth header on every call.

Can I limit what my agent is allowed to do with the Click2Mail REST API?

Yes. Jentic One is self-hosted, so your own rules decide which Click2Mail operations and credentials your agent may use. You can allow document uploads to POST /documents and job status reads on GET /jobs/{id} while withholding job submission on POST /jobs/{id}/submit until you explicitly grant it. Because Click2Mail puts the job id in the URL path, a rule can also pin the agent to a specific mailing job rather than acting across the whole account.