latestOpenAPI 3.1.0MIT2026-08-102046250.0 KB

67cb925f1c81

Batches

Update a Batch message

This operation updates all specified parameters of a batch that matches the provided batch ID.

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

Request body

OR
OR

Example request

{
  "from": "+15551231234",
  "to_add": [
    "+15551231234"
  ],
  "to_remove": [
    "+15551231234"
  ]
}

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