Delete an Email or Push campaign schedule
delete
/rest/api/v1.3/campaigns/{campaignName}/schedule/{scheduleId}
Request
Path Parameters
-
campaignName: string
Campaign Name
-
scheduleId: string
Schedule Id
Response
Supported Media Types
- application/json
Default Response
Root Schema : Update Email or Push Campaign Schedule Response
Type:
object
Title:
Show Source
Update Email or Push Campaign Schedule Response
-
id(optional):
string
ID of the schedule.
-
launchOptions(optional):
object launchOptions
Launch Options for the schedule.
-
scheduledTime(optional):
string
Date in the format yyyy-mm-dd HH:mm
-
scheduleType(optional):
string
Allowed Values:
[ "NOW", "ONCE" ]
Schedule Type.
Nested Schema : launchOptions
Type:
object
Launch Options for the schedule.
Show Source
-
proofLaunch(optional):
boolean
Should a proof launch be performed.
Examples
The following example shows how to delete the schedule of an existing Email campaign or Push campaign using the schedule ID, thereby unscheduling the launch. The schedule ID 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.
NOTES:
- A Responsys user must create the campaign in Responsys, and the campaign must not have validation errors.
- For Email campaigns, the interfaces apply for only Email Message Designer (EMD) campaigns; the interfaces do not support classic campaigns.
- For Push campaigns, your Push campaign must have the "From address" set in the Launch Options of the campaign workbook. If the "From address" is not set, the campaign will be scheduled successfully, but the campaign launch will fail.
- The APIs support Push campaigns only for the Mobile App channel. The API does not support In-app Message campaigns.
A successful request requires the following headers:
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
Example Request URL:
/rest/api/v1.3/campaigns/test/schedule/1491
Sample Response:Success
{ "id": 1491, "scheduleType": "ONCE", "scheduledTime": "2018-11-30 01:00 AM", "launchOptions": { "proofLaunch": false }, "links": [ { "rel": "self", "href": "/rest/api/v1.3/campaigns/test/schedule/1491", "method": "DELETE" }, { "rel": "updateSchedule", "href": "/rest/api/v1.3/campaigns/test/schedule/1491", "method": "PUT" }, { "rel": "getSchedule", "href": "/rest/api/v1.3/campaigns/test/schedule/1491", "method": "GET" }, { "rel": "createSchedule", "href": "/rest/api/v1.3/campaigns/test/schedule", "method": "POST" } ] }