POST /transactionalSMS/sms
Send a transactional SMS message to a single mobile number. The sender, recipient, and either content or templateId fields are required. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the recipient must be a valid international phone number (6-15 digits, optional leading +). Tags can be a string or an array of up to 10 strings. The SMS type defaults to transactional but can be set to marketing; if the content includes a stop code, it is automatically treated as marketing. Returns the message ID, SMS count, credits used, and remaining credits.
Servers
- 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 |
|---|---|---|---|
params |
Object | No |
Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}. These are the placeholder variables in the template that will be replaced with the corresponding values passed in the params object. Applicable only if |
unicodeEnabled |
Boolean | No |
Format of the message. It indicates whether the content should be treated as unicode or not. Default value: false |
type |
String | No |
Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. Valid values:
Default value: "transactional" |
content |
String | Yes |
Content of the message. If more than 160 characters long, will be sent as multiple text messages. Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed. |
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. Alphanumeric sender names (up to 11 characters) must contain only letters and digits. Numeric sender names (12-15 characters) must contain only digits. |
webUrl |
String | No |
Webhook to call for each event triggered by the message (delivered etc.) |
tag |
Object | No |
Tag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string. |
recipient |
String | Yes |
Mobile number to send SMS with the country code. Must contain between 6 and 15 digits, optionally prefixed with '+'. |
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.