Skip to main content
POST

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
body
string
required

The message body (if not defined in the flow).

Maximum string length: 1000
​
to
object[]
required

List of recipients.

Required array length: 1 - 10 elements
​
callback
string<uri>

Callback URL for receiving delivery notifications (Webhook, see Webhooks).

​
tag
string
default:promotional

Tag for the message. You can use it to group messages (e.g. by campaign id). There are also some special tags you can use: priority (for priority messages), transactional (for transactional messages).

​
params
object

By providing this object, you can pass special parameters to the message. Ask us how to use this parameter for shortening links or other features.

​
datetime
string<date-time>

Scheduled time for sending the message. Always in UTC timezone.

Example:

"2025-01-11T10:00:00Z"

​
delivery_time
object
​
flow
object[]

A list of communication channels for the message flow. If defined, must not be empty. You can use multiple channels, the order of channels is important (first channel is the first to be used, if the first channel is not available or recipient does not accept it, the second channel is used, etc.).

​
payload
object

You can send the message payload, where you can define any parameters for the message. This object is returned in the delivery notification and replies.

Example:

Response

Messages sent successfully

​
request_id
string

Unique request identifier.

​
accepted
object[]
​
rejected
object[]