Create SMS Broadcast

POST

https://apicfa.convirza.com/v2/broadcasts

SMS Broadcast

Last modified:2026-04-03 12:54:09

Create a new SMS broadcast by selecting individual contacts or entire contact lists. Either contact_ids or contact_list_ids must be provided, but not both.

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

🟢200

application/json

Broadcast created successfully with bulk_sms_conversations_id

Headers

Body

🟠400

🟠401

🟠403

🟠404

🔴500

⚪default

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://apicfa.convirza.com/v2/broadcasts' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "broadcast_name": "string",
    "tracking_number": "string",
    "agent_ring_to": "string",
    "message": "string",
    "contact_ids": [
        0
    ],
    "contact_list_ids": [
        0
    ],
    "group_id": 0,
    "is_scheduled": true,
    "schedule_datetime": "2019-08-24T14:15:22.123Z"
}'

Response Example

200 - Example 1

{
    "result": "string",
    "err": "string",
    "data": "string"
}

Modified at 2026-04-03 12:54:09

List Broadcasts

Update Broadcast