smsCampaigns

Creates an SMS campaign

Create a new SMS campaign with the required name, sender, and content fields. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the content should stay within 160 characters per SMS segment. If a scheduledAt date is provided, listIds in recipients become mandatory; accounts under validation are limited to 4 total campaigns and campaigns with more than 10 recipients will be saved as draft.

post/smsCampaigns

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/smsCampaigns
  • Auth: API key in header api-key

Request body

contentstring required

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.

namestring required

Name of the campaign

organisationPrefixstring

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.

scheduledAtstring

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.

senderstring required

Name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters

unicodeEnabledboolean

Format of the message. It indicates whether the content should be treated as unicode or not.

unsubscribeInstructionstring

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.

Response

successfully created

idinteger required

ID of the object created

Changes

No recorded changes to this operation across all 1 revision of this API.