POST
/
api
/
v1
/
email
/
send

Authorizations

Authorization
string
headerrequired

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

Body

application/json
inbox_id
string
required

The ID of the inbox to send the email from

to_addresses
object[]
cc_addresses
object[]
bcc_addresses
object[]
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

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

plain_text
string | null

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

html
string | null

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

alternative_content
boolean
default: false

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

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

message_type
enum<string>
Available options:
forward,
reply,
new
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

Response

200 - application/json
id
string
required

The ID of the email