Skip to main content
POST
Send multiple messages

Body

application/json
Required array length: 1 - 10 elements
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 delivery notifications.

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).

datetime
string<date-time>

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

Example:

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

delivery_time
object
flow
object[]

A list of communication channels for the message flow. If defined, must not be empty.

payload
object

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

Example:

Response

Messages sent successfully

requestId
string

Unique request identifier.

accepted
object[]
rejected
object[]