Sign in
latestOpenAPI 3.1.0MIT2026-08-102046250.0 KB

67cb925f1c81

Batches

Replace a batch

This operation will replace all the parameters of a batch with the provided values. It is the same as cancelling a batch and sending a new one instead.

put/xms/v1/{service_plan_id}/batches/{batch_id}

Request body

OR
OR

Example request

{
  "to": [
    "+15551231234",
    "+15551256344"
  ],
  "from": "+15551231234",
  "send_at": "2024-08-07T12:34:56.789Z"
}

Response

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"
}