Create Broadcast

POST

https://platform-api.convirza.com/v3/broadcast

SMS Broadcasts

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

Creates a new SMS broadcast conversation and prepares message records for all targeted recipients.

Request rules:

Exactly one recipient source must be provided: either contact_ids or contact_list_ids.

phone_number and agent_ring_to are normalized and must resolve to valid 10-digit numbers.

org_unit_id must be a positive integer.

If is_scheduled=true, schedule_datetime is required.

Behavior:

Validates recipient IDs against existing contacts/contact lists.

Excludes invalid/empty phone numbers and stores only normalized destinations.

Inserts broadcast data in chunks for large recipient volumes.

Sets status to pending for immediate sends, or scheduled when schedule data is provided.

Response:

Returns bulk_sms_conversations_id for subsequent read/update/patch/cancel operations.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Broadcast created successfully

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://platform-api.convirza.com/v3/broadcast' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "broadcast_name": "Spring Offer Blast",
    "phone_number": "3675431235",
    "agent_ring_to": "7645341235",
    "message": "Limited-time spring offer. Reply YES to learn more.",
    "contact_ids": [
        101,
        102,
        103
    ],
    "contact_list_ids": [
        21,
        25
    ],
    "org_unit_id": 12,
    "is_scheduled": false,
    "schedule_datetime": "2026-03-05T10:00:00.000Z"
}'

Response Example

201 - 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

List Broadcasts

Get Broadcast Details