Skip to main content
POST
Send message to contact

Authorizations

Authorization
string
header
required

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

Path Parameters

identifier
string
required

Contact identifier: the numeric contact id, an email address, or a phone number.

Minimum string length: 1

Body

application/json
text
string

Message text.

Required string length: 1 - 1000
files
any[]

Media files to attach, up to 5MB each.

Minimum array length: 1
mediaFile
object

Media library file reference to attach.

mediaFileId
string

Media library file id (numeric string) to attach.

Pattern: ^\d+$
mediaFileIds
string[]

Media library file ids (numeric strings) to attach, up to 10.

Required array length: 1 - 10 elements
Pattern: ^\d+$
flowId
string

Flow id (numeric string) to send instead of a plain message. Get it from flows.list.

Pattern: ^\d+$
nodeId
string

Node id within the flow to start from. Defaults to the flow's start node.

Pattern: ^\d+$
inboxId
string

ID of the channel to send the message on. null to send message on the last interacted channel (if any).

Pattern: ^\d+$
clientId
string

Client-generated id echoed back for de-duplication.

Pattern: ^\d+$
replyToMessageId
string

Id of the message this one replies to.

replyToMessageCreatedAt
string<date-time>

Creation timestamp of the message this one replies to.

isPrivateReply
boolean

When true, sends as a comment-anchored private reply DM instead of a public comment reply.

Response

OK

The response is of type any.