Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
  1. SMS Broadcasts
  • Platform
    • Users
      • List Users
      • Get User Details
      • Update User
      • Partial Update User
      • Delete User
      • Create User
    • Groups
      • List Child Groups
      • Get Group Tree
      • Get Group Details
      • List Groups
      • Get Org Unit Hierarchy
      • Update Group
      • Partial Update Group
      • Delete Group
      • Create Group
    • Webhooks
      • List Webhooks
      • Get Webhook Details
      • Update Webhook
      • Partial Update Webhook
      • Delete Webhook
      • Create Webhook
    • Media Prompts
      • List Prompts
      • Upload Prompt
      • Delete Prompt
  • AI Voice Agents
    • List AI Voice Agents
      GET
    • Create Agent
      POST
    • Get Agent Details
      GET
    • Update Agent
      PUT
    • Partial Update Agent
      PATCH
    • Delete Agent
      DELETE
  • Phone Numbers
    • Assigned Numbers
      GET
    • Provisioned Numbers
      GET
    • Reserved Numbers
      DELETE
    • Phone Numbers
      POST
    • Available Numbers
      GET
  • Provisioned Routes
    • List Provisioned Routes
      GET
    • Create Provisioned Route
      POST
    • Get Provisioned Route Details
      GET
    • Delete Provisioned Route
      DELETE
    • Update Provisioned Route
      PUT
    • Partial Update Provisioned Route
      PATCH
  • SMS Broadcasts
    • List Broadcasts
      GET
    • Create Broadcast
      POST
    • Get Broadcast Details
      GET
    • Update Broadcast
      PUT
    • Partial Update Broadcast
      PATCH
    • Delete Broadcast
      DELETE
  • Conversation
    • Calls
      • Get Calls List
      • Get Call By ID
    • SMS
      • Get SMS Conversations
  • Miscellaneous
    • List Ad Sources
    • List Industries
    • List Tags
    • Create Tag
    • Update Tag
    • Delete Tag
  1. SMS Broadcasts

Partial Update Broadcast

PATCH
https://platform-api.convirza.com/v3/broadcast/{broadcast_id}
SMS Broadcasts
Last modified:2026-04-03 14:27:57
Applies partial updates to selected broadcast fields without replacing the full record.
Patch supports:
Metadata updates: broadcast_name, group_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 ********************
or
Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Broadcast patched successfully
Body

🟠400
🟠401
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://platform-api.convirza.com/v3/broadcast/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "broadcast_name": "Updated Broadcast Name",
    "phone_number": "3675431235",
    "agent_ring_to": "7645341235",
    "message": "Final reminder: event starts in 1 hour.",
    "group_id": 12,
    "contact_ids": [
        101,
        102,
        103
    ],
    "contact_list_ids": [
        21,
        25
    ],
    "is_scheduled": true,
    "schedule_datetime": "2026-03-05T09:00:00.000Z"
}'
Response 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
Previous
Update Broadcast
Next
Delete Broadcast
Built with