Marketing CampaignsSMS Campaigns

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.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

campaignIdlongRequired
id of the SMS campaign

Request

Values to update an SMS Campaign
contentstringOptional

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

namestringOptional
Name of the campaign
organisationPrefixstringOptional

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.

recipientsobjectOptional
scheduledAtstringOptional

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.

senderstringOptional<=15 characters

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

unicodeEnabledbooleanOptionalDefaults to false
Format of the message. It indicates whether the content should be treated as unicode or not.
unsubscribeInstructionstringOptional
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.**

Errors

400
Bad Request Error
404
Not Found Error