For AI agents: visit https://developers.click2mail.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Click2Mail
HomeGuidesRecipesAPI EndpointsCommunity
Click2Mail
Guides
HomeGuidesRecipesAPI EndpointsCommunity

The Basics

  • Introduction
  • Quick Start Guide
  • Getting Access to the API
  • Building Your First API Call
  • Next Steps

Get Started Mailing

  • Your First Mail Job
  • Add Credit
  • Upload a Document
  • Upload an Address List
  • Create a Job
  • Submit a Job
  • Check Job Status
  • Check on Tracking
  • Next Steps

Optimize Your Mailing

  • Installing Postman
  • Setting up Click2Mail's Postman Collection
  • Using Job Templates for Jobs
  • Batch API
  • Handling Large Documents
  • Using Variable Data / Mail Merge

Using the SDK

  • Introduction
  • Python SDK
    • Contents of the Python SDK
    • Using the Python SDK
    • c2mAPIRest Object
    • c2mAPIBatch Object
    • returnAddress Object
    • printOptions Object

Resources

  • FAQs
  • API 101
  • HTTP Response Codes
  • Supported Document Types
  • Other Helpful Information
  • Getting More Help
Powered by 

SDKs and Code Examples

We have created a set of SDKs to simplify using our API. Each of these, along with a some other sample code, can be found on the Click2Mail GitHub site.

  • Python
  • PHP 5.6 and later
  • PHP 5.5 and earlier
  • Ruby
  • Node.js
  • Java
  • VB .NET
  • C# .NET
  • Postman

Updated over 1 year ago


Introduction