Send an SMS Batch

In addition to sending a single SMS, you can also send a batch of SMS using this endpoint.

POST

/sms/send/bulk

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.

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.

unicode

string

Controls how Unicode characters are handled for this message. Accepted values are Allow, Deny, and Strip.

clientReference

string

Your own reference for this message, useful for billing, analytics, and matching delivery receipts back to your system.

sendAtUtc

string

format: date-time (ISO 8601)

The date (UTC) in ISO 8601 format for when the SMS should be scheduled. If not specified, the SMS will be sent immediately.

enableLinkShortening

boolean

Overrides your Workspace link shortening setting for this batch. Set true to enable link shortening for messages in this send, or false to disable it.

Response Data

JSON Data

batchId

string

format: long / int64

The SMS Batch ID from Connect.

messageCount

number

The number of messages in the batch.

errors

array

When some messages fail validation but others are accepted, this contains the message index and validation error for each failed item.

If some messages are accepted and some fail validation, the API returns 207 Multi-Status with the accepted messageCount and an errors array.

Integration Sample

curl -X POST https://connect-api.divergent.cloud/sms/send/bulk \
  -H "X-Api-Key: { API_KEY }" \
  --json '{
    "sendAtUtc": "2026-05-21T12:00:00Z",
    "enableLinkShortening": true,
    "messages": [
      {
        "sender": "{ SENDER_NAME }",
        "recipient": "{ RECIPIENT_NUMBER }",
        "content": "{ CONTENT }",
        "unicode": "Allow",
        "clientReference": "{ CLIENT_REFERENCE }"
      }
    ]
  }'