Send Campaign Message
Last updated
Last updated
POST
https://api.oneroute.io/api/public/whatsapp/campaign
This endpoint is designed for WhatsApp template campaigns with many recipients.
Template messages can be delivered at any time. Each template needs to be registered and pre-approved by WhatsApp
We recommend sending the campaign in one request so that it can be grouped else it will be treated as an individual request. All recipients, corresponding templates, and template parameters are included in an array as shown in the example request payload below
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
To get the status of your campaign, you may call the logs API, and pass the campaign ID. A request will also be pushed to your registered webhook upon campaign completion
apiKey
string
API Key for authentication.
messages.*.save
boolean
To save the message as a conversation on OneRoute or not.
messages.*.template
object
The template object
messages
array
An array of messages to send
from
string
messages.*.to
string
Whatsapp number to send template message to.
messages.*.template.name
string
the template name