Authentication

All CMR API requests require your partner API key. Depending on the endpoint, you may also need to pass a userId query parameter.

Two Auth Modes

Every endpoint uses exactly one of the following modes.

Partner-level auth

User-level auth

Pass only the cmr-x-api-key header. Used for account-level operations that aren't tied to a specific customer.

Endpoints that use partner-level auth:

Endpoint	Description
`POST /users`	Create a new user
`GET /users/list`	List all users under your account
`DELETE /users`	Delete a user
`GET /users/get-dashboard-configurations`	Fetch partner dashboard config
`GET /geo`	List supported countries
`GET /geo/ip`	Detect IP location

Your API Key

API keys are issued when you sign up as a CMR reseller. View and manage them at https://partners.coldmailreseller.com.

DANGER

Never expose your API key in client-side code, mobile apps, or public repositories. Your key controls billing and all resources under your partner account. All CMR API calls must originate from your backend server.

Code Examples

JavaScript

Python

cURL

Error Reference

Condition	Status	Message
Missing `cmr-x-api-key` header	`401`	`Please provide an api key or generate one from the dashboard. Visit https://integrations.coldmailreseller.com`
Invalid or unknown API key	`401`	`Invalid api key`
Missing `userId` on user-level endpoint	`400`	`Please provide a userId`
`userId` not found under your account	`404`	`The requested user does not exist.`

Next Steps

Users

Create users and retrieve their userId for use on all subsequent requests.

Errors

Full HTTP status code reference and retry strategy.

Quick Start

Provision your first domain and mailbox end-to-end.

Two Auth Modes#

Your API Key#

Code Examples#

Error Reference#

Next Steps#

Two Auth Modes

Your API Key

Code Examples

Error Reference

Next Steps