Update Broadcast

PUT

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

SMS Broadcasts

Last modified:2026-04-03 14:27:57

Updates the broadcast payload for an existing scheduled broadcast.

What this endpoint updates:

Core metadata (broadcast_name, optional group_id).

Message and dial fields (message, phone_number, agent_ring_to).

Recipient set by rebuilding broadcast recipient rows from contact_ids or contact_list_ids.

Schedule datetime when provided and changed.

Important constraints:

Works only for broadcasts that have an existing schedule record.

Broadcast cannot be edited if send time is within next 15 minutes or already passed.

Requires either contact_ids or contact_list_ids (not both).

If is_scheduled=true, schedule_datetime must be provided.

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 updated successfully

Body

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://platform-api.convirza.com/v3/broadcast/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "broadcast_name": "Updated Spring Offer Blast",
    "phone_number": "3675431235",
    "agent_ring_to": "7645341235",
    "message": "Updated message content for spring offer.",
    "contact_ids": [
        101,
        102,
        103
    ],
    "contact_list_ids": [
        21,
        25
    ],
    "group_id": 12,
    "is_scheduled": true,
    "schedule_datetime": "2026-03-06T09:30: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-04-03 14:27:57

Get Broadcast Details

Partial Update Broadcast