GET /smsCampaigns

Servers

Query parameters

Name Type Required Description
endDate String No

Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )

limit Integer No

Number limitation for the result returned

Default value: 500

status String No

Status of campaign.

Valid values:

  • "sent"
  • "suspended"
  • "queued"
  • "archive"
  • "inProcess"
  • "draft"
startDate String No

Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )

offset Integer No

Beginning point in the list to retrieve from.

Default value: 0

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.