POST
/
v1
/
messages

Authorizations

Authorization
string
headerrequired

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

Body

application/json
bcc
string[]
body
string
required

The full HTML body of the message. Messages with only plain-text representations are up-converted to HTML.

cc
string[]
channel_id
string

Identifier of the channel through which the conversation is taking place. Either channel_id or reply_to_message_id must be provided.

conversation_id
string

Identifier of the conversation the message belongs to.

from
string
quote_body
string

Body for the quote that the message is referencing. Only available on email channels.

recipients
object[]

The name/handle pairs of the recipients, including to, cc, and bcc.

reply_to_message_id
string

The ID of the message that you're replying to. Either channel_id or reply_to_message_id must be provided

reply_type
enum<string>

The type of reply that you're sending. If not provided, the channel will determine the reply type.

Available options:
reply,
reply_all,
forward
sender
object

The name/handle pairs of the recipients, including to, cc, and bcc.

subject
string

Subject of the email message, if applicable. Null for non-email conversations.

to
string[]

Response

200 - application/json
attachments
object[]

An array of Attachment objects.

body
string

The full HTML body of the message without quotations.

channel_id
string
required

Identifier of the channel through which the conversation is taking place.

conversation_id
string
required

Identifier of the conversation the message belongs to.

created_at
string
required

The ISO 8601 time at which the Message was created.

date
string
required

ISO 8601 time of when the message was sent.

direction
enum<string>
required

Whether the message is inbound or outbound.

Available options:
inbound,
outbound
external_message_id
string

The identifier of the message in an external system.

format
enum<string>
required
Available options:
minimal,
full
id
string
required

Unique identifier of the message.

raw_body
string

The raw HTML body of the message. Messages with only plain-text representations are up-converted to HTML.

recipients
object[]
required

The name/handle pairs of the recipients, including to, cc, and bcc.

reply_to_message_id
string

The ID of the message that you're replying to. For Gmail and Microsoft Graph, this is the provider ID of the message that you're replying to.

reply_type
enum<string>

The type of reply that you're sending. If not provided, the channel will determine the reply type.

Available options:
reply,
reply_all,
forward
sender
object
required

The name/handle pairs of the recipients, including to, cc, and bcc.

snippet
string

A short preview of the message body, generated by the channel provider

subject
string

Subject of the email message, if applicable. Null for non-email conversations.

text_body
string

The text content of body