Sign in

v1

latestSwagger 2.02026-08-06114161439.7 KB
SMS Broadcast

Update broadcast SMS

Update broadcast SMS details. Provide either contact_ids or contact_list_ids, but not both.

put/broadcasts/{broadcast_id}

Path parameters

broadcast_idinteger required

The ID of the broadcast to update

Request body

tracking_numberstring required

Phone number the caller dialed (the tracking/DNI number). Convirza routes calls from this number through the configured call flow. String of digits.

agent_ring_tostring required

Phone number of the agent receiving SMS replies. String. Must resolve to 10 digits; formatting like parentheses, dashes, or '+1' prefix is accepted.

messagestring required

SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated).

contact_idsinteger[]

List of contact IDs. Use this or contact_list_ids (not both). Type: array of integer.

contact_list_idsinteger[]

List of contact list IDs. Use this or contact_ids (not both). Type: array of integer.

schedule_datetimestring

When to send the broadcast, required when is_scheduled=true. Format 'YYYY-MM-DD HH:mm:ss'.

ouidinteger

Org unit ID (group ID) for the broadcast. Type: integer.

is_scheduledboolean

Boolean. If true, the broadcast is queued for future delivery; if false, it sends immediately. Default false.

Example request

{
  "tracking_number": "string",
  "agent_ring_to": "string",
  "message": "string",
  "contact_ids": [
    0
  ],
  "contact_list_ids": [
    0
  ],
  "schedule_datetime": "string",
  "is_scheduled": true
}

Response

Broadcast updated successfully

resultstring required

Outcome of the request. String, typically 'success' or 'error'.

errstring required

Error message when result='error'. String. Empty/null on success.

datastring

Response payload. Shape varies by endpoint.