Update Email or Push Campaign Launch Schedule

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

Service URL:

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

Required Path Parameter:

• campaignName
• scheduleId (this can be obtained from the id parameter from 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:

PUT

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Required Body Parameters:

• scheduleType (ONCE or NOW)
• scheduledTime (Date in the format YYYY-MM-DD HH:MM AM or PM)

Sample Request Body:

In this example, we have a campaign launch with schedule ID of 244797 with a scheduled time of 2016-12-30 11:17 AM. We want to change the launch time to 1:00 AM. The campaign name and schedule ID are sent as part of the endpoint, and the request body contains the desired changes:

{
   "scheduleType": "ONCE",
   "scheduledTime": "2016-12-30 1:00 AM"
}

Sample Response Body:

The response to the above request returns the launch schedule information, showing the new scheduledTime.

{
  "id": 244797,
  "scheduleType": "ONCE",
  "scheduledTime": "2016-12-30 01:00 AM",
  "launchOptions": {
    "proofLaunch": false,
    "progressEmailAddresses": [
      "email1@ora.com",
      "email2@ora.com"
    ],
    "progressChunk": "CHUNK_10K"
  },
  "links": [
    {
      "rel": "self",
      "href": "/rest/api/v1.3/campaigns/JMP Test for API/schedule/244797",
      "method": "PUT"
    },
    {
      "rel": "deleteSchedule",
      "href": "/rest/api/v1.3/campaigns/JMP Test for API/schedule/244797",
      "method": "DELETE"
    },
    {
      "rel": "getSchedule",
      "href": "/rest/api/v1.3/campaigns/JMP Test for API/schedule/244797",
      "method": "GET"
    },
    {
      "rel": "createSchedule",
      "href": "/rest/api/v1.3/campaigns/JMP Test for API/schedule",
      "method": "POST"
    }
  ]
}