Skip to main content

Email Gateway API

Send transactional and marketing emails, manage domains, configure webhooks, and monitor usage — all through a single REST API.

Base URL​

The Email Gateway API is built on REST principles. To prioritize security, HTTPS is mandatory for all requests, and HTTP is not supported.

All requests contain the following base URL:

https://api.cm.com/email/

Authentication​

To authenticate you will need a secure credential called the Product Token. This token acts as your unique key to authenticate requests.

How to Obtain the Product Token:

  • Log in to the Email Gateway App.
  • Navigate to the Settings page within the app.
  • Locate and copy your Product Token in the Integration section.

When making a request to the API, include the Product Token in the request headers. Use the header name X-CM-PRODUCTTOKEN and pass the token as its value. For example, in a POST request, your header should look like this:

curl -X POST "https://api.cm.com/email/gateway/v1/transactional?priority={priority}" \
-H "Content-Type: application/json" \
-H "X-CM-PRODUCTTOKEN: {your-product-token}" \
-d '{your-json-payload}'
POST https://api.cm.com/email/gateway/v1/transactional?priority={priority}
Content-Type: application/json
X-CM-PRODUCTTOKEN: {your-product-token}

Response Codes​

The API follows standard HTTP status codes to communicate the outcome of your requests. Here's a breakdown of how these codes are used:

  • 2xx: Indicates a successful request.
  • 4xx: Represents client-side errors, such as invalid input or authentication issues.
  • 5xx: Signals server-side errors or infrastructure problems.
StatusMeaning
200Request was successful.
400Invalid parameters; check your input.
401Missing Product Token.
403Invalid Product Token.
404Resource not found.
429Rate limit exceeded.
5xxServer error on CM.com's side.

These codes help you quickly identify and troubleshoot issues with your API requests.

API Reference​

Explore detailed endpoint documentation in the API Reference section, organized by feature:

  • Send Email — POST transactional and marketing messages
  • Email Configuration — Manage domains and DNS settings
  • Webhooks — Configure event notifications
  • Usage Alerts — Monitor email consumption
  • Suppressions — Manage bounces and unsubscribes