Partial Update Broadcast

PATCH

https://platform-api.convirza.com/v3/broadcast/{broadcast_id}

SMS Broadcasts

Last modified:2026-07-24 13:10:44

Applies partial updates to selected broadcast fields without replacing the full record.

Patch supports:

Metadata updates: broadcast_name, org_unit_id.

Delivery fields: message, phone_number, agent_ring_to.

Recipient updates: contact_ids or contact_list_ids (cannot use both).

Schedule control: is_scheduled and/or schedule_datetime.

Scheduling behavior:

is_scheduled=false removes existing schedule.

is_scheduled=true with schedule_datetime creates or updates schedule.

Scheduling changes are blocked within 15 minutes of execution time.

Validation:

At least one field must be supplied in the request body.

Broadcast must exist and must not be cancelled.

When updating recipients, provide either contact_ids or contact_list_ids, not both.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Broadcast patched successfully

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request PATCH 'https://platform-api.convirza.com/v3/broadcast/{broadcast_id}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "broadcast_name": "Updated Broadcast Name",
    "phone_number": "3675431235",
    "agent_ring_to": "7645341235",
    "message": "Final reminder: event starts in 1 hour.",
    "org_unit_id": 12,
    "contact_ids": [
        101,
        102,
        103
    ],
    "contact_list_ids": [
        21,
        25
    ],
    "is_scheduled": true,
    "schedule_datetime": "2026-03-05T09:00:00.000Z"
}'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "bulk_sms_conversations_id": 1
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-07-24 13:10:44

Update Broadcast

Delete Broadcast