Schedule
Schedule
Event List
The DisplayGroupId to return the event list for.
Date in Y-m-d H:i:s
Date in Y-m-d H:i:s
Date in Y-m-d H:i:s
successful response
No content
GET /api/schedule/{displayGroupId}/events HTTP/1.1
Accept: */*
successful response
No content
Filter grid by eventTypeId. * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
From Date in Y-m-d H:i:s format
To Date in Y-m-d H:i:s format
Flag (0-1), whether to return events using Geo Location
Flag (0-1), whether to return Recurring events
Filter events by specific campaignId
Filter events by an array of Display Group Ids
Specifies which field the results are sorted by. Used together with sortDir
Sort direction
successful operation
GET /api/schedule HTTP/1.1
Accept: */*
successful operation
[
{
"eventId": 1,
"eventTypeId": 1,
"campaignId": 1,
"commandId": 1,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"scheduleReminders": [
{
"scheduleReminderId": 1,
"eventId": 1,
"value": 1,
"type": 1,
"option": 1,
"isEmail": 1,
"reminderDt": 1,
"lastReminderDt": 1
}
],
"criteria": [],
"userId": 1,
"fromDt": 1,
"toDt": 1,
"isPriority": 1,
"displayOrder": 1,
"recurrenceType": "None",
"recurrenceDetail": 1,
"recurrenceRange": 1,
"recurrenceRepeatsOn": "text",
"recurrenceMonthlyRepeatsOn": 1,
"campaign": "text",
"command": "text",
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1,
"syncEvent": 1,
"syncTimezone": 1,
"shareOfVoice": 1,
"maxPlaysPerHour": 1,
"isGeoAware": 1,
"geoLocation": "text",
"actionTriggerCode": "text",
"actionType": "text",
"actionLayoutCode": "text",
"parentCampaignId": 1,
"syncGroupId": 1,
"dataSetId": 1,
"dataSetParams": 1,
"modifiedBy": 1,
"createdOn": "text",
"updatedOn": "text",
"name": "text",
"resolutionId": 1,
"layoutDuration": 1,
"backgroundColor": "text"
}
]Add a new scheduled event for a Campaign/Layout to be shown on a Display Group/Display.
The Event Type Id to use for this Event. * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
The Campaign ID to use for this Event. * If a Layout is needed then the Campaign specific ID for that Layout should be used.
For Media or Playlist event Type. The Layout specific Campaign ID to use for this Event. * This needs to be the Layout created with layout/fullscreen function
The Command ID to use for this Event.
The Media ID to use for this Event.
The display order for this event.
An integer indicating the priority of this event. Normal events have a priority of 0.
The Display Group IDs for this event. Display specific Group IDs should be used to schedule on single displays.
The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
Should this schedule be synced to the resulting Display timezone?
The from date for this event.
The to date for this event.
The type of recurrence to apply to this event.
The interval for the recurrence.
The end date for this events recurrence.
The days of the week that this event repeats - weekly only
Flag (0-1), whether this event is using Geo Location
Array of comma separated strings each with comma separated pair of coordinates
Valid GeoJSON string, use as an alternative to geoLocation parameter
For Action eventTypeId, the type of the action - command or navLayout
For Action eventTypeId, the webhook trigger code for the Action
For Action eventTypeId and navLayout actionType, the Layout Code identifier
For Data Connector eventTypeId, the DataSet ID
For Data Connector eventTypeId, the DataSet params
successful operation
POST /api/schedule HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 631
"eventTypeId=1&campaignId=1&fullScreenCampaignId=1&commandId=1&mediaId=1&displayOrder=1&isPriority=1&displayGroupIds=[1]&dayPartId=1&syncTimezone=1&fromDt='2026-01-01T00:00:00.000Z'&toDt='2026-01-01T00:00:00.000Z'&recurrenceType=''&recurrenceDetail=1&recurrenceRange='2026-01-01T00:00:00.000Z'&recurrenceRepeatsOn=[1]&scheduleReminders=[{'reminder_value':1,'reminder_type':1,'reminder_option':1,'reminder_isEmailHidden':1}]&isGeoAware=1&geoLocation=['text']&geoLocationJson='text'&actionType='text'&actionTriggerCode='text'&actionLayoutCode='text'&dataSetId=1&dataSetParams='text'"successful operation
{
"eventId": 1,
"eventTypeId": 1,
"campaignId": 1,
"commandId": 1,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"scheduleReminders": [
{
"scheduleReminderId": 1,
"eventId": 1,
"value": 1,
"type": 1,
"option": 1,
"isEmail": 1,
"reminderDt": 1,
"lastReminderDt": 1
}
],
"criteria": [],
"userId": 1,
"fromDt": 1,
"toDt": 1,
"isPriority": 1,
"displayOrder": 1,
"recurrenceType": "None",
"recurrenceDetail": 1,
"recurrenceRange": 1,
"recurrenceRepeatsOn": "text",
"recurrenceMonthlyRepeatsOn": 1,
"campaign": "text",
"command": "text",
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1,
"syncEvent": 1,
"syncTimezone": 1,
"shareOfVoice": 1,
"maxPlaysPerHour": 1,
"isGeoAware": 1,
"geoLocation": "text",
"actionTriggerCode": "text",
"actionType": "text",
"actionLayoutCode": "text",
"parentCampaignId": 1,
"syncGroupId": 1,
"dataSetId": 1,
"dataSetParams": 1,
"modifiedBy": 1,
"createdOn": "text",
"updatedOn": "text",
"name": "text",
"resolutionId": 1,
"layoutDuration": 1,
"backgroundColor": "text"
}Delete a Recurring Event of a Scheduled Event
The Scheduled Event ID
successful operation
No content
DELETE /api/schedulerecurrence/{eventId} HTTP/1.1
Accept: */*
successful operation
No content
Get the Schedule object specified by the provided eventId
Numeric ID of the Scheduled Event to get
successful operation
Class Schedule
The ID of this Event
The Event Type ID
The CampaignID this event is for
The CommandId this event is for
The userId that owns this event.
A Unix timestamp representing the from date of this event in CMS time.
A Unix timestamp representing the to date of this event in CMS time.
Integer indicating the event priority.
The display order for this event.
If this event recurs when what is the recurrence period.
If this event recurs when what is the recurrence frequency.
A Unix timestamp indicating the end time of the recurring events.
Recurrence repeats on days - 0 to 7 where 0 is a monday
Recurrence monthly repeats on - 0 is day of month, 1 is weekday of week
The Campaign/Layout Name
The Command Name
The Day Part Id
Is this event an always on event?
Does this event have custom from/to date times?
Flag indicating whether the event should be synchronised across displays
Flag indicating whether the event will sync to the Display timezone
Seconds (0-3600) of each full hour that is scheduled that this Layout should occupy
The maximum number of plays per hour per display for this event
Flag (0-1), whether this event is using Geo Location
Geo JSON representing the area of this event
For Action event type, Action trigger code
For Action event type, the type of the Action (navigate to Layout or Command)
For Action event type and navigate to Layout Action type, the Layout code
If the schedule should be considered part of a larger campaign
For sync events, the id the the sync group
For data connector events, the dataSetId
For data connector events, the data set parameters
The userId of the user that last modified this Schedule
The Date this Schedule was created on
The Date this Schedule was las updated on
The name of this Scheduled Event
The resolutionId of this Fullscreen Scheduled Event
The duration of this Fullscreen Scheduled Event
The background color of this Fullscreen Scheduled Event
GET /api/schedule/{eventId} HTTP/1.1
Accept: */*
successful operation
{
"eventId": 1,
"eventTypeId": 1,
"campaignId": 1,
"commandId": 1,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"scheduleReminders": [
{
"scheduleReminderId": 1,
"eventId": 1,
"value": 1,
"type": 1,
"option": 1,
"isEmail": 1,
"reminderDt": 1,
"lastReminderDt": 1
}
],
"criteria": [],
"userId": 1,
"fromDt": 1,
"toDt": 1,
"isPriority": 1,
"displayOrder": 1,
"recurrenceType": "None",
"recurrenceDetail": 1,
"recurrenceRange": 1,
"recurrenceRepeatsOn": "text",
"recurrenceMonthlyRepeatsOn": 1,
"campaign": "text",
"command": "text",
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1,
"syncEvent": 1,
"syncTimezone": 1,
"shareOfVoice": 1,
"maxPlaysPerHour": 1,
"isGeoAware": 1,
"geoLocation": "text",
"actionTriggerCode": "text",
"actionType": "text",
"actionLayoutCode": "text",
"parentCampaignId": 1,
"syncGroupId": 1,
"dataSetId": 1,
"dataSetParams": 1,
"modifiedBy": 1,
"createdOn": "text",
"updatedOn": "text",
"name": "text",
"resolutionId": 1,
"layoutDuration": 1,
"backgroundColor": "text"
}Edit a scheduled event for a Campaign/Layout to be shown on a Display Group/Display.
The Scheduled Event ID
The Event Type Id to use for this Event. * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action
The Campaign ID to use for this Event. * If a Layout is needed then the Campaign specific ID for that Layout should be used.
The Command ID to use for this Event.
The Media ID to use for this Event.
The display order for this event.
An integer indicating the priority of this event. Normal events have a priority of 0.
The Display Group IDs for this event. * Display specific Group IDs should be used to schedule on single displays.
The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
Should this schedule be synced to the resulting Display timezone?
The from date for this event.
The to date for this event.
The type of recurrence to apply to this event.
The interval for the recurrence.
The end date for this events recurrence.
The days of the week that this event repeats - weekly only
Flag (0-1), whether this event is using Geo Location
Array of comma separated strings each with comma separated pair of coordinates
Valid GeoJSON string, use as an alternative to geoLocation parameter
For Action eventTypeId, the type of the action - command or navLayout
For Action eventTypeId, the webhook trigger code for the Action
For Action eventTypeId and navLayout actionType, the Layout Code identifier
For Data Connector eventTypeId, the DataSet ID
For Data Connector eventTypeId, the DataSet params
successful operation
Class Schedule
The ID of this Event
The Event Type ID
The CampaignID this event is for
The CommandId this event is for
The userId that owns this event.
A Unix timestamp representing the from date of this event in CMS time.
A Unix timestamp representing the to date of this event in CMS time.
Integer indicating the event priority.
The display order for this event.
If this event recurs when what is the recurrence period.
If this event recurs when what is the recurrence frequency.
A Unix timestamp indicating the end time of the recurring events.
Recurrence repeats on days - 0 to 7 where 0 is a monday
Recurrence monthly repeats on - 0 is day of month, 1 is weekday of week
The Campaign/Layout Name
The Command Name
The Day Part Id
Is this event an always on event?
Does this event have custom from/to date times?
Flag indicating whether the event should be synchronised across displays
Flag indicating whether the event will sync to the Display timezone
Seconds (0-3600) of each full hour that is scheduled that this Layout should occupy
The maximum number of plays per hour per display for this event
Flag (0-1), whether this event is using Geo Location
Geo JSON representing the area of this event
For Action event type, Action trigger code
For Action event type, the type of the Action (navigate to Layout or Command)
For Action event type and navigate to Layout Action type, the Layout code
If the schedule should be considered part of a larger campaign
For sync events, the id the the sync group
For data connector events, the dataSetId
For data connector events, the data set parameters
The userId of the user that last modified this Schedule
The Date this Schedule was created on
The Date this Schedule was las updated on
The name of this Scheduled Event
The resolutionId of this Fullscreen Scheduled Event
The duration of this Fullscreen Scheduled Event
The background color of this Fullscreen Scheduled Event
PUT /api/schedule/{eventId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 606
"eventTypeId=1&campaignId=1&commandId=1&mediaId=1&displayOrder=1&isPriority=1&displayGroupIds=[1]&dayPartId=1&syncTimezone=1&fromDt='2026-01-01T00:00:00.000Z'&toDt='2026-01-01T00:00:00.000Z'&recurrenceType=''&recurrenceDetail=1&recurrenceRange='2026-01-01T00:00:00.000Z'&recurrenceRepeatsOn=[1]&scheduleReminders=[{'reminder_value':1,'reminder_type':1,'reminder_option':1,'reminder_isEmailHidden':1}]&isGeoAware=1&geoLocation=['text']&geoLocationJson='text'&actionType='text'&actionTriggerCode='text'&actionLayoutCode='text'&dataSetId=1&dataSetParams='text'"successful operation
{
"eventId": 1,
"eventTypeId": 1,
"campaignId": 1,
"commandId": 1,
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"scheduleReminders": [
{
"scheduleReminderId": 1,
"eventId": 1,
"value": 1,
"type": 1,
"option": 1,
"isEmail": 1,
"reminderDt": 1,
"lastReminderDt": 1
}
],
"criteria": [],
"userId": 1,
"fromDt": 1,
"toDt": 1,
"isPriority": 1,
"displayOrder": 1,
"recurrenceType": "None",
"recurrenceDetail": 1,
"recurrenceRange": 1,
"recurrenceRepeatsOn": "text",
"recurrenceMonthlyRepeatsOn": 1,
"campaign": "text",
"command": "text",
"dayPartId": 1,
"isAlways": 1,
"isCustom": 1,
"syncEvent": 1,
"syncTimezone": 1,
"shareOfVoice": 1,
"maxPlaysPerHour": 1,
"isGeoAware": 1,
"geoLocation": "text",
"actionTriggerCode": "text",
"actionType": "text",
"actionLayoutCode": "text",
"parentCampaignId": 1,
"syncGroupId": 1,
"dataSetId": 1,
"dataSetParams": 1,
"modifiedBy": 1,
"createdOn": "text",
"updatedOn": "text",
"name": "text",
"resolutionId": 1,
"layoutDuration": 1,
"backgroundColor": "text"
}Last updated
Was this helpful?