Import text message

This endpoint is rate limited to 60 per minute

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required

The channel_id (for now only SMS or WhatsApp channels are supported). Needs access to channel

int32

ticket_id, which will be used to thread messages, otherwise contact_id will be used

string
required

The ticket status if a new ticket is created with this imported message. Either 'OPEN' or 'CLOSED'.

string
required

string (max 65000 chars)

string
required

Either 'INBOUND', 'OUTBOUND' or 'NOTE'

int32

The user_id, required when the message type is OUTBOUND

string

Required if first message in ticket (if ticket_id is null) or type is 'INBOUND', Eg: "+31xxxxxxxxx"

boolean
Defaults to false

Either true or false

date
required

Must be in the past, ISO 8601 format e.g. 2020-01-01T10:11:12+01:00

boolean
Defaults to true

Marks the imported message as read or unread based on the boolean value.

file

Attachment file per request. Since email attachments and chat attachments work differently, we can import one attachment per request.

boolean

When set to true and message is of type INBOUND, Journey automations with trigger Message Received will be triggered.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json