Skip to main content
POST
Send a message

Authorizations

Authorization
string
header
required

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

Path Parameters

thread_id
string
required

Body

application/json
content
string
required

Message body (HTML).

Minimum string length: 1
cc
object[]

Applied only to email-channel threads.

bcc
object[]

Applied only to email-channel threads.

attachments
object[]

Applied only to email-channel threads.

channel_id
string

Slack channel id. Required for Slack threads unless one is stored on the thread.

author
enum<string>

user (default) sends the message as your workspace user. On a custom thread nothing is delivered: message.sent carries the reply to your integration. contact records the message as inbound from the thread's contact. On email and live chat threads that triggers nothing; on a custom thread it works like an inbound email: the thread reopens, notifications fire and the AI agent may answer. Not supported on Slack and Teams threads.

Available options:
user,
contact
external_message_id
string

Custom channel threads only: your id for an inbound message. A repeat with the same id returns the stored message and creates nothing.

Required string length: 1 - 255

Response

Successful response

id
string
required
thread_id
string
required
channel
enum<string>
required
Available options:
email,
slack,
live_chat,
teams,
custom
custom_channel
string | null

Channel name on a custom thread, such as whatsapp.

deduplicated
boolean

True when external_message_id matched a stored message and nothing new was created.