Skip to main content
POST
Send text message

Authorizations

Authorization
string
header
required

Token JWT de autenticação

Headers

x-company-id
string

Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.

Body

application/json
conversationId
string
required

Conversation ID

message
object
required
followup
string

Follow-up ID (optional)

Response

Message sent successfully

content
string
required

Message content

content_type
enum<string>
required

Content type: TEXT, IMAGE, AUDIO, VIDEO, DOCUMENT, TEMPLATE, etc.

Available options:
TEXT,
CARDS,
AUDIO,
VIDEO,
IMAGE,
DOCUMENT,
CONTACTS,
LOCATION,
TEMPLATE,
STICKER,
UNSUPPORTED
message_type
enum<string>
required

Message type: INCOMING, OUTGOING, ACTIVITY

Available options:
INCOMING,
OUTGOING,
ACTIVITY
status
enum<string>
required

Message status: SENT, DELIVERED, READ, FAILED

Available options:
SENT,
DELIVERED,
READ,
FAILED
conversation
any
required

Conversation associated with the message

inbox
any
required

Message's inbox

contact
any
required

Message's contact

company
any
required

Message's company

_id
string

Message ID

additional_attributes
any

Additional message attributes

sender_type
enum<string>

Sender type: CONTACT, USER, BOT, SYSTEM

Available options:
CONTACT,
USER,
BOT,
SYSTEM
source_id
string

Message ID in the external platform

user
any

User who sent the message

attachments
any[]

Message attachments

errors
object[]

List of errors associated with the message

createdAt
any

Message creation date

updatedAt
any

Message update date