POST
/
api
/
v1
/
email
/
send

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
from_address
object
required

The address to send the email from. You must own the inbox that this address is associated with

alternative_content
boolean
default:
false

If true, html and plain_text are alternative representations of the same content

attachment_ids
string[]

The IDs of the attachments to include in the email from the attachments pool. See here for more information on the attachments pool

bcc_addresses
object[]
cc_addresses
object[]
existing_email_id
string | null

The BotMailRoom ID of the email to reply to or forward. Can be null if the email is a new email

html
string | null

The html content of the email. Can be null if the email is only available in plain text

idempotency_key
string | null

A unique identifier for the email. If the same request is sent multiple times with the same idempotency key, only the first email will be sent

message_type
enum<string>
Available options:
forward,
reply,
new
open_and_click_tracking
boolean | null

If true, open and click tracking will be enabled for the email. If false, open and click tracking will be disabled for the email. If null, open and click tracking will be enabled if the inbox has open and click tracking enabled

plain_text
string | null

The plain text content of the email. Can be null if the email is only available in html

reply_to_addresses
object[]
subject
string | null

The subject of the email. If not provided, the subject of the original email will be used. Must be provided for new emails

to_addresses
object[]

Response

200 - application/json
id
string
required

The ID of the email