PUT /smsCampaigns/{campaignId}

Servers

Path parameters

Name Type Required Description
campaignId Integer Yes

id of the SMS campaign

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
name String No

Name of the campaign

recipients Object No
recipients.listIds[] Array Yes

Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty

recipients.exclusionListIds[] Array No

List ids which have to be excluded from a campaign

content String No

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

sender String No

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

scheduledAt String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.