smsCampaigns

Update an SMS campaign

Update an existing SMS campaign''s properties such as name, sender, content, recipients, scheduled date, organisation prefix, and unsubscribe instructions. The request body must contain at least one valid field to update. The campaign must exist and must be of type SMS; if a scheduledAt is provided, valid recipients must be present either in the request or already configured on the campaign.

put/smsCampaigns/{campaignId}

Request

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

Path parameters

campaignIdinteger required

id of the SMS campaign

Request body

contentstring

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

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

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

SMS campaign updated

object required

Changes

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