Get All Launch Schedules for an Email or Push Campaign

Use this interface to get all the schedules for an Email or a Push campaign, including all schedule IDs for the launches.

Service URL:

/rest/api/v1.3/campaigns/{campaignName}/schedule

Required Path Parameter:

campaignName

Request Method:

GET

Request Header:

Authorization=<AUTH_TOKEN>

Request Parameters:

offset: starts at 0 and indicates the record number for the response result set

limit: number of campaigns to return in the response (defaults to 200 and cannot exceed 200)

Request Body:

None

Sample Response Body

The following successful response is for a campaign named testCampaign that has two active launches. The active launch with Scheduled ID 307357 is of type RECURRING that occurs daily, starting on February 9, 2017 and ending on February 23, 2017. The active launch with Schedule ID 307377 is of type ONCE that will occur on February 3, 2017 at noon.

{
  "schedules": [
    {
      "id": 307357,
      "scheduleType": "RECURRING",
      "scheduledTime": "2017-02-09 10:00 AM",
      "recurringEndTime": "2017-02-23 12:00 AM",
      "recurringInterval": "DAILY",
      "launchOptions": {
        "proofLaunch": false
      },
      "links": [
        {
          "rel": "self",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule/307357",
          "method": "GET"
        },
        {
          "rel": "deleteSchedule",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule/307357",
          "method": "DELETE"
        },
        {
          "rel": "updateSchedule",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule/307357",
          "method": "PUT"
        },
        {
          "rel": "createSchedule",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule",
          "method": "POST"
        }
      ]
    },
    {
      "id": 307377,
      "scheduleType": "ONCE",
      "scheduledTime": "2017-02-03 12:00 PM",
      "launchOptions": {
        "proofLaunch": false
      },
      "links": [
        {
          "rel": "self",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule/307377",
          "method": "GET"
        },
        {
          "rel": "deleteSchedule",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule/307377",
          "method": "DELETE"
        },
        {
          "rel": "updateSchedule",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule/307377",
          "method": "PUT"
        },
        {
          "rel": "createSchedule",
          "href": "/rest/api/v1.3/campaigns/testCampaign/schedule",
          "method": "POST"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "/rest/api/v1.3/campaigns/testCampaign/schedule",
      "method": "GET"
    }
  ]
}

Sample Response in case of failure:

{
  "title": "Campaign not found",
  "errorCode": "CAMPAIGN_NOT_FOUND",
  "detail": "Campaign not found with name [campaignName]"
}