Marketing CampaignsSMS Campaigns

Creates an SMS campaign

Authentication

api-keystring

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

Request

Values to create an SMS Campaign
contentstringRequired

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.

namestringRequired
Name of the campaign
senderstringRequired<=15 characters

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

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.

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.

Response

successfully created
idlong
ID of the object created

Errors