Email: Send an email

post

https://partner-api-url.com/send-email

Send email. Returns 200 OK on successful send. On failure, we distinguish between permanent and temporary errors. Status codes above 500 and also 429 will be retried later. Other non-200 status codes will result in the enqueue_failed event.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Channel API access and fees
The Channel API is available to partners and clients who want to build connectors to Communications Platform as a Service (CPaaS) vendors or Mail Transfer Agents (MTAs, also known as ESPs) such as Mailgun, Sinch, Infobip, and Omnivery.
Channel API access isn't enabled by default and is subject to additional fees. To get access, contact your Account Manager.

Body Params

from

object

required

Single mailbox

object

required

Single mailbox

subject

string

required

Subject line

content

string

required

HTML email context

text_content

string

Text-only email content

attachments

array of objects

Any number of attachments

attachments

reply_to

object

Single mailbox

custom_headers

object

Other headers, if allowed by provider

precedence_bulk

boolean

Whether to include Precedence: Bulk

request_id

string

required

Unique request ID which can be used for deduplication. This may be the only way to ensure exactly-once delivery in case of send endpoint timeouts.

custom_data

string

required

Custom obscure BR data metadata which need to be stored on provider's side, passed to webhook callbacks. Will be URL safe and usually a few hundred characters long.

callback_url

string

required

Webhook URL where to send delivery reports along with custom_data.

metadata

object

required

BR metadata that can be used by provider if needed

Headers

Chan-Example-Token

string

required

Defaults to 123

An example header (one of multiple) containing account identity or authorization data. The actual headers to be sent can be customized to provider's needs, by default BR will send each setting field as a separate header with the prefix Chan- added to the name.

An API key is a token that you provide when making API calls. Include the token in a header parameter called Chan-Example-Token.

Example: Chan-Example-Token: 123

Responses

Channel API access and fees

200200

4XX4XX

5XX5XX