POST /whatsappCampaigns
Create and Send a WhatsApp campaignServers
- https://api.brevo.com/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Name of the WhatsApp campaign creation |
recipients |
Object | Yes |
Segment ids and List ids to include/exclude from campaign |
recipients.excludedListIds[] |
Array | No |
List ids to exclude from the campaign |
recipients.listIds[] |
Array | No |
Mandatory if scheduledAt is not empty. List Ids to send the campaign to |
recipients.segments[] |
Array | No |
Mandatory if listIds are not used. Segment ids to send the campaign to. |
templateId |
Integer | Yes |
Id of the WhatsApp template in approved state |
scheduledAt |
String | Yes |
Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.For example: 2017-06-01T12:30:00+02:00 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.