POST /smsCampaigns
Creates an SMS 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 campaign |
recipients |
Object | No | |
recipients.listIds[] |
Array | Yes |
Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty |
recipients.exclusionListIds[] |
Array | No |
List ids which have to be excluded from a campaign |
unicodeEnabled |
Boolean | No |
Format of the message. It indicates whether the content should be treated as unicode or not. Default value: false |
content |
String | Yes |
Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS. |
organisationPrefix |
String | No |
A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms. |
sender |
String | Yes |
Name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters |
unsubscribeInstruction |
String | No |
Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include STOP keyword. This will be added as instructions after the end of message content. Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms. |
scheduledAt |
String | No |
UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. |
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.