Create SMS Campaign

Options

Body

Values to create an SMS Campaign

Request body which must comply to the following JSON Schema:

{
  "required" : [ "content", "name", "sender" ],
  "type" : "object",
  "properties" : {
    "name" : {
      "type" : "string",
      "description" : "Name of the campaign",
      "example" : "Spring Promo Code"
    },
    "sender" : {
      "maxLength" : 15,
      "type" : "string",
      "description" : "Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**\n",
      "example" : "MyShop"
    },
    "content" : {
      "type" : "string",
      "description" : "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\n",
      "example" : "Get a discount by visiting our NY store and saying : Happy Spring!"
    },
    "recipients" : {
      "required" : [ "listIds" ],
      "type" : "object",
      "properties" : {
        "listIds" : {
          "type" : "array",
          "description" : "Lists Ids to send the campaign to. **REQUIRED if scheduledAt is not empty**\n",
          "items" : {
            "type" : "integer",
            "description" : "List Id to send the campaign to",
            "format" : "int64",
            "example" : 54
          }
        },
        "exclusionListIds" : {
          "type" : "array",
          "description" : "List ids which have to be excluded from a campaign",
          "items" : {
            "type" : "integer",
            "description" : "List Id to exclude from the campaign",
            "format" : "int64",
            "example" : 15
          }
        }
      }
    },
    "scheduledAt" : {
      "type" : "string",
      "description" : "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.**\n",
      "example" : "2017-05-05T12:30:00+02:00"
    },
    "unicodeEnabled" : {
      "type" : "boolean",
      "description" : "Format of the message. It indicates whether the content should be treated as unicode or not.\n",
      "example" : true,
      "default" : false
    },
    "organisationPrefix" : {
      "type" : "string",
      "description" : "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.**",
      "example" : "MyCompany"
    },
    "unsubscribeInstruction" : {
      "type" : "string",
      "description" : "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" : "send Stop if you want to unsubscribe."
    }
  }
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers