Skip to main content
POST
Add ColdSend native inbox

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Body

application/json

Request to create a ColdSend native inbox.

ColdSend native inboxes are created on domains managed by ColdSend infrastructure. They use Azure Communication Services for sending and Stalwart for receiving.

domain_id
string<uuid>
required

Domain ID where the inbox will be created. The domain must be verified and active in your workspace.

email_prefix
string
required

Email prefix (part before @, e.g., 'support', 'john', 'outreach')

Required string length: 1 - 64
display_name
string
required

Display name shown in recipient's inbox (e.g., 'John Smith from Company')

Required string length: 1 - 255

Response

ColdSend inbox created successfully

Response for ColdSend inbox creation.

success
boolean
required
message
string
required
inbox_id
string<uuid>
required

Created inbox ID

email_address
string
required

Full email address

display_name
string
required

Display name

domain_id
string<uuid>
required

Domain ID

domain_name
string
required

Domain name

overall_status
string
required

Inbox status

created_at
string<date-time>
required

Creation timestamp