Skip to main content

Frequently Asked Questions

General​

What is the difference between an API Broadcast and Compose Message?​

Compose Message is for sending messages manually from the EzPulze UI — you pick recipients, select a template, and send.

API Broadcasts are for sending messages programmatically from external systems. You create a broadcast once, then your CRM, website, or automation tool calls the webhook URL whenever it needs to send a message.

Do I need an API key to use API Broadcasts?​

Yes. Every API call to a broadcast webhook must include a valid API key with Broadcast scope in the Authorization header. Create one in API Keys.

Can I use the same API key for multiple broadcasts?​

Yes. One API key with Broadcast scope can be used to call any broadcast's webhook URL. However, for better tracking and security, consider creating separate keys for different integrations.

Creating and editing​

Why can't I change the template on an API broadcast?​

The template is locked after creation for API broadcasts because your external systems send parameters that match the current template structure. Changing the template would break those integrations. To use a different template, create a new broadcast.

Why is the broadcast name locked on some broadcasts?​

For Direct and Ad type broadcasts, the name is system-generated and cannot be changed. These broadcasts are created automatically when messages are sent from the Chat page or ad integrations.

What does assigning agents do?​

When a contact replies to a broadcast message, the conversation is routed to the assigned agents. If no agents are assigned, replies go to the general queue.

API integration​

Where do I find the webhook URL for my broadcast?​

Go to API Keys → open the API Documentation page → select your broadcast from the dropdown. The webhook URL and a complete cURL example are displayed.

What parameters do I need to send?​

The parameters depend on your template. The API Documentation page auto-generates the exact payload structure based on your template's components (header, body, buttons, carousel). Use the generated cURL example as your reference.

What happens if I call the webhook with an invalid API key?​

You'll receive a 401 Unauthorized error. Make sure your API key is active and has Broadcast scope.

What happens if the linked template gets paused or disabled?​

Messages will fail to send. You'll see failed counts in the API key usage stats. Check your template status in WhatsApp Templates and ensure it's approved.

Is there a rate limit for API calls?​

Yes, rate limits are set per API key. The default is 1,000 requests per hour. You can configure this in the API key's Advanced Settings.

Troubleshooting​

Messages aren't being sent​

Check these things:

  1. Is the broadcast Active? — inactive broadcasts don't process messages
  2. Is the API key valid? — check it's active and has Broadcast scope
  3. Is the template approved? — paused or disabled templates will cause failures
  4. Is the payload correct? — use the auto-generated cURL example to verify your request structure
  5. Have you hit the rate limit? — check the API key's rate limit setting

I'm getting a 403 error​

Your API key doesn't have the required Broadcast scope. Edit the key in API Keys and add Broadcast permissions.

I deleted a broadcast by mistake​

Deleted broadcasts cannot be recovered. Create a new broadcast with the same template and update your external systems with the new webhook URL.