Send an SMS Batch
This content is not available in your language yet.
In addition to sending a single SMS, you can also send a batch of up to 500 messages in a single request using this endpoint.
POST /sms/send/bulk
POST
/sms/send/bulk
Request Data
Section titled “Request Data”Headers
X-Api-Key
required
string
The API Key for your Workspace.
JSON Data
messages
required
array
An array of messages to send. Maximum 500 per batch.
sender
required
string
Sender Name for the SMS.
recipient
required
string
format: E.164 Recipient Number (E.164 format) for the SMS.
content
required
string
The Content of the SMS to send.
clientReference
string
Your own reference for this individual message, returned on delivery receipt webhooks.
unicode
string
format: Allow | Deny | Strip How to handle unicode characters: Allow (default), Deny or Strip.
clientTag
string
A grouping tag applied to every message in the batch for usage reporting. Normalized to lowercase a–z, 0–9 and hyphens (max 64 chars).
enableLinkShortening
boolean
Automatically shorten links across every message in the batch. Defaults to the Workspace setting if omitted.
sendAtUtc
string
format: date-time (ISO 8601) The date (UTC) in ISO 8601 format for when the batch should be scheduled. If not specified, the batch will be sent immediately.
Response Data
Section titled “Response Data”JSON Data
batchId
string
format: long / int64 The SMS Batch ID from Connect.
messageCount
number
The number of messages accepted into the batch.
errors
array (optional)
Per-message errors, present only when some messages failed validation (see Partial Success below).
index
number
The zero-based index of the failed message in your messages array.
error
string
The reason the message was rejected.
Partial Success
Section titled “Partial Success”Batches are validated message-by-message, so it’s possible for some messages to send while others fail.
200 OK
207 Multi-Status
400 Bad Request
Every message in the batch was accepted.
207 Multi-Status
Some messages were accepted and queued, while others failed validation. The accepted messages are still sent, and the errors array lists each rejected message by index.
400 Bad Request
No messages were sent. This happens when the whole request is invalid, or when too many messages (25 or more) failed validation — in which case processing is stopped so you can fix the errors and try again.