Retrieve an Email or Push campaign schedule
get
/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 : Email or Push Campaign Schedule
Type:
object
Title:
Show Source
Email or Push Campaign Schedule
-
id(optional):
string
ID of the schedule.
-
launchOptions(optional):
object launchOptions
Launch Options for the schedule.
-
recurringEndTime(optional):
string
Date in the format yyyy-mm-dd HH:mm
-
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
-
progressChunk(optional):
string
Allowed Values:
[ "CHUNK_10K", "CHUNK_50K", "CHUNK_100K", "CHUNK_500K", "CHUNK_1M" ]
Progress Chunk. -
progressEmailAddresses(optional):
array progressEmailAddresses
Email addresses to inform of progress.
-
proofLaunch(optional):
boolean
Should a proof launch be performed.
-
proofLaunchEmail(optional):
string
Email address for the proof launch.
-
proofLaunchType(optional):
string
Allowed Values:
[ "LAUNCH_TO_ADDRESS", "LAUNCH_TO_PROOFLIST", "LAUNCH_TO_ADDRESS_USING_PROOFLIST" ]
Proof Launch type. -
recipientLimit(optional):
integer
Recipient Limit.
-
samplingNthInterval(optional):
integer
Sampling Interval.
-
samplingNthOffset(optional):
integer
Sampling offset.
-
samplingNthSelection(optional):
integer
Sampling Selection.
Nested Schema : progressEmailAddresses
Type:
array
Email addresses to inform of progress.
Show Source
Examples
The following example shows how to retrieve an Email or a Push campaign schedule by its schedule ID. 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> |
Sample request URL:
/rest/api/v1.3/campaigns/test/schedule/1491
Sample Response: Success
For the above request to get the schedule for a proof launch of an Email campaign named test with a launch schedule ID of 1491, the system returns the following response:
{ "id": 1491, "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/1491", "method": "POST" }, { "rel": "createSchedule", "href": "/rest/api/v1.3/campaigns/test/schedule", "method": "GET" }, { "rel": "updateSchedule", "href": "rest/api/v1.3/campaigns/test/schedule/1491", "method": "PUT" }, { "rel": "deleteSchedule", "href": "rest/api/v1.3/campaigns/test/schedule/1491", "method": "DELETE" } ] } }