v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

SMS Campaigns

Creates an SMS campaign

post/smsCampaigns

Request body

namestring required

Name of the campaign

senderstring required

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

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

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.

unicodeEnabledboolean

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

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.

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.

Example request

{
  "name": "Spring Promo Code",
  "sender": "MyShop",
  "content": "Get a discount by visiting our NY store and saying : Happy Spring !",
  "recipients": {
    "listIds": [
      54
    ],
    "exclusionListIds": [
      15
    ]
  },
  "scheduledAt": "2017-05-05T12:30:00+02:00",
  "unicodeEnabled": true,
  "organisationPrefix": "MyCompany",
  "unsubscribeInstruction": "send Stop if you want to unsubscribe."
}

Response

SMS campaign created

idinteger required

ID of the object created

Example response

{
  "id": 122
}