Managing Broadcasts

This page covers creating, editing, deleting, and managing API broadcasts.

Broadcast list

The list displays all broadcasts in a table:

Column	Description
Campaign Name	Broadcast name (hover for full text)
Template Name	The linked WhatsApp template
Agents	Assigned agents, or "No agents assigned"
Created Date	Creation date and time (sortable)
Broadcast Type	API, Direct, Scheduled, Automated, or Manual
Status	Active or Inactive (sortable)
Actions	Edit and Delete buttons

📸

Screenshot: Broadcast list table with campaigns showing name, template, agents, type, and status columns

broadcasts-list-table.png

1. Go to Developer Tools → API Broadcasts
2. Capture the table with several broadcasts in different statuses
Save to: static/img/screenshots/dashboard/broadcasts-list-table.png

Pagination

Page sizes: 25, 50, or 100 per page. Navigate with first/previous/next/last buttons.

Mobile view

On smaller screens, broadcasts display as cards showing the campaign name, template, status badge, agent count, type, and created date.

Search and filters

Search

Type in the search bar to find broadcasts by name. Results update as you type.

Filters

Click the Filter button to expand the filter panel:

Filter	Options
Status	Active, Inactive
Broadcast Type	All Types, API (default), Direct, Scheduled, Automated, Manual

📸

Screenshot: Filter panel with Status and Broadcast Type dropdowns

broadcasts-filter-panel.png

1. Click the Filter button
2. Capture the expanded panel with both dropdown filters and Apply/Reset buttons
Save to: static/img/screenshots/dashboard/broadcasts-filter-panel.png

Click Apply to filter or Reset to return to the default (API type only).

info

By default, the page shows only API type broadcasts. Change the Broadcast Type filter to see other types.

Creating a broadcast

Click Create API Broadcast
A side drawer opens with the creation form

📸

Screenshot: Create New Broadcast drawer with name, template, and agent fields

create-broadcast-drawer.png

1. Click Create API Broadcast
2. Capture the drawer with all fields and the info box
Save to: static/img/screenshots/dashboard/create-broadcast-drawer.png

Form fields

Field	Required	Description
Broadcast Name	Yes	Auto-generated as `BROADCAST_YYYYMMDD_HHMMSS` — you can edit it
Select Template	Yes	Choose an approved WhatsApp template (searchable dropdown)
Assign Agents	No	Select one or more agents to handle replies

Steps

Enter a name (or keep the auto-generated one)
Select a template — type to search
Optionally assign agents
Click Create Broadcast

After creation:

The broadcast appears in the list as Active
Go to API Keys to create a key with Broadcast scope
Use the API Documentation page to get the webhook URL and cURL example for this broadcast

tip

Use descriptive names like "Website Lead Follow-up" or "CRM Deal Notification" — they appear in API key usage stats and help you track which broadcasts are being used.

Editing a broadcast

Click the Edit button (pencil icon) on any broadcast to open the edit drawer.

📸

Screenshot: Edit Broadcast drawer showing editable and locked fields

edit-broadcast-drawer.png

1. Click the Edit icon on a broadcast
2. Capture the drawer with the warning about field restrictions
Save to: static/img/screenshots/dashboard/edit-broadcast-drawer.png

What you can change

Field restrictions depend on the broadcast type:

Broadcast Type	Name	Template	Agents
API	Editable	Locked	Editable
Scheduled	Editable	Locked	Editable
Automated	Editable	Locked	Editable
Manual	Editable	Locked	Editable
Direct	Locked	Editable	Editable
Ad	Locked	Editable	Editable

Agents can always be changed — this lets you reassign reply handling at any time.

Locked fields show a hint explaining why they can't be modified. For API broadcasts, the template is locked because changing it would break existing API integrations that send parameters matching the current template structure.

Deleting a broadcast

Click the Delete button (trash icon) on any broadcast
Confirm in the dialog

warning

Deleting a broadcast removes its webhook integration. Any external systems calling that webhook URL will start receiving errors. Make sure to update your integrations before deleting.

Bulk actions

Change the status of multiple broadcasts at once:

Select broadcasts using checkboxes (or the master checkbox for all)
A selection bar appears: "No of Selected items: X out of Y"
Click Select Action
Choose a new status from the dropdown
Click Apply

📸

Screenshot: Selection bar with item count and bulk action dialog

broadcasts-bulk-action.png

1. Select multiple broadcasts with checkboxes
2. Capture the selection bar and the bulk action dialog
Save to: static/img/screenshots/dashboard/broadcasts-bulk-action.png

Using your broadcast with an API key

Once your broadcast is created, here's how to connect it to your system:

1. Create an API key

Go to API Keys and create a key with Broadcast scope. This key authenticates your API calls.

2. Get the webhook URL

On the API Documentation page, select your broadcast from the dropdown. The page shows:

Webhook URL — the endpoint to call
API Key — for authentication (masked by default, click to reveal)
cURL example — auto-generated with your template's parameters

3. Call the API

Send a POST request to the webhook URL with your API key and the contact's details:

curl -X POST "{webhook_url}" \
  -H "Authorization: Bearer {your_api_key}" \
  -H "Content-Type: application/json" \
  -d '{
    "mobile": "+1234567890",
    "components": [
      {
        "type": "body",
        "parameters": [
          { "type": "text", "text": "John" }
        ]
      }
    ]
  }'

The components structure must match your template's parameters — use the auto-generated cURL example as a reference.

4. Track delivery

Monitor message delivery in API Key usage stats, which shows sent, delivered, read, and failed counts.

Header actions

Button	What it does
Filter	Toggle the filter panel
Manage API Keys	Navigate to API Keys
Create API Broadcast	Open the creation drawer

Permissions

Action	Required permission
View broadcasts	Broadcast read access
Create broadcasts	Broadcast create access
Edit broadcasts	Broadcast update access
Delete broadcasts	Broadcast delete access
Bulk status change	Broadcast update access

Broadcast list​

Pagination​

Mobile view​

Search and filters​

Search​

Filters​

Creating a broadcast​

Form fields​

Steps​

Editing a broadcast​

What you can change​

Deleting a broadcast​

Bulk actions​

Using your broadcast with an API key​

1. Create an API key​

2. Get the webhook URL​

3. Call the API​

4. Track delivery​

Header actions​

Permissions​