Sign in
latestOpenAPI 3.1.0MIT2026-08-102046250.0 KB

67cb925f1c81

Batches

Send

Send a message or a batch of messages.

Depending on the length of the body, one message might be split into multiple parts and charged accordingly.

Any groups targeted in a scheduled batch will be evaluated at the time of sending. If a group is deleted between batch creation and scheduled date, it will be considered empty.

Be sure to use the correct region in the server URL.

post/xms/v1/{service_plan_id}/batches

Request body

OR
OR

Example request

{
  "to": [
    "+15551231234",
    "+15551256344"
  ],
  "from": "+15551231234",
  "body": "Hi ${name}! How are you?",
  "send_at": "2024-08-07T12:34:56.789Z"
}

Response

Created. A successful response, or an Error.

OR
OR

Example response

{
  "id": "01FC66621XXXXX119Z8PMV1QPQ",
  "to": [
    "+15551231234",
    "+15551256344"
  ],
  "from": "+15551231234",
  "body": "Hi ${name}! How are you?",
  "client_reference": "myReference"
}