Schedule
Overview
The Schedule endpoint allows you to create a new schedule, to request information about an existing schedule, or to stop / start a schedule.
For more details on how to set up a Schedule API request, please see the Schedule API Technical Guide.
Endpoint (North America): https://api.eccmp.com/services2/api/Schedule
Endpoint (Europe): https://api.ccmp.eu/services2/api/Schedule
Endpoint (Japan): https://api.marketingsuite.jp/services2/api/Schedule
GET Methods
The Schedule endpoint supports the following GET operation. This endpoint allows you to retrieve the schedule details by providing the Schedule ID. Please note that the platform doesn't provide a mechanism to look up the Schedule ID; please contact your Client Services Representative if you need help finding the value of a Schedule ID.
Click hereClick here to see a sample response message in JSON format.
{
"scheduleId": 18550,
"endTime": "2017-01-15T00:00:00",
"timeZone": "SE_Asia_Standard_Time",
"dayFrequency": {
"frequencyType": "Weekly",
"weeklyInterval": "Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday"
},
"timeFrequency": {
"timeIntervalType": "MutipleTimesADay",
"multipleTimesInterval": {
"runInterval": 8,
"excludeTimeBefore": "2017-01-01T00:00:01",
"excludeTimeAfter": "2017-01-01T23:59:59"
}
}
}
POST Method
The Schedule endpoint supports the following POST operations.
Create a New Schedule
This endpoint allows you to define the details of a new schedule. The new schedule must include the following rules:
Optionally, a schedule starting date / time and ending date / time.
Time zone used to calculate times.
Frequency -- daily, monthly, or yearly -- and the frequency interval.
Time of the day that the schedule should run -- either once a day at a specified time, or multiple times a day at a specified frequency.
Click hereClick here to see a sample request message in JSON format.
{
"StartTime": "2017-01-01T00:00:01",
"EndTime": "2017-02-02T00:00:01",
"timeZone": "Eastern_Standard_Time",
"dayFrequency": {
"frequencyType": "Daily",
"daysInterval": 1
},
"timeFrequency": {
"timeIntervalType": "MutipleTimesADay",
"multipleTimesInterval": {
"excludeTimeBefore": "2017-01-01T00:00:01",
"excludeTimeAfter": "2017-01-01T23:59:59"
}
}
}
Click hereClick here to see a sample response message in JSON format.
{
"scheduleId": 48219,
"startTime": "2017-01-01T00:00:01",
"endTime": "2017-02-02T00:00:01",
"timeZone": "Eastern_Standard_Time",
"dayFrequency": {
"frequencyType": "Daily",
"daysInterval": 1
},
"timeFrequency": {
"timeIntervalType": "MutipleTimesADay",
"multipleTimesInterval": {
"excludeTimeBefore": "2017-01-01T00:00:01",
"excludeTimeAfter": "2017-01-01T23:59:59"
}
}
}
Pause / Resume a Schedule
This endpoint allows you to start or stop a schedule by providing the Schedule ID.
Back to API Category - Campaign Management