Get a Launch Schedule for an Email or Push Campaign

Use this interface to get the schedule of an Email or Push campaign by using the campaign schedule ID that was returned from the schedule campaign API.

Service URL:

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

OR

/rest/api/v1.3/campaigns?type=email

Required Path Parameters:

• campaignName
• scheduleId (this can be obtained from the id parameter from the response to either the “Get All Launch Schedules for an Email or Push Campaign” task or the “Schedule an Email or Push Campaign Launch” task)

Request Method:

GET

Request Header:

Authorization=<AUTH_TOKEN>

Request Body - Required Properties:

None

Sample Request Body

Not applicable

Sample Response Body

The following response example was for a proof launch of an Email campaign named test with a launch schedule ID of 1.

{
  "id": 1,
  "scheduleType": "ONCE",
  "scheduledTime": "2019-01-25 06:00 AM",
  "launchOptions": {
    "proofLaunch": true,
    "proofLaunchEmail": "someemail@a.com",
    "proofLaunchType": "LAUNCH_TO_ADDRESS",
    "recipientLimit": 3,
    "samplingNthSelection": 1,
    "samplingNthOffset": 1,
    "samplingNthInterval": 1,
    "progressEmailAddresses": [
      "email1@a.com",
      "email2@a.com"
    ],
    "progressChunk": "CHUNK_10K",
    "links": [
      {
        "rel": "self",
        "href": "/rest/api/v1.3/campaigns/test/schedule/1",
        "method": "POST"
      },
      {
        "rel": "createSchedule",
        "href": "/rest/api/v1.3/campaigns/test/schedule",
        "method": "GET"
      },
      {
        "rel": "updateSchedule",
        "href": "rest/api/v1.3/campaigns/test/schedule/1",
        "method": "PUT"
      },
      {
        "rel": "deleteSchedule",
        "href": "rest/api/v1.3/campaigns/test/schedule/1",
        "method": "DELETE"
      }
    ]
  }
}