schedule

Edit Schedule Event

Changed on

Edit a scheduled event for a Campaign/Layout to be shown on a Display Group/Display.

put/schedule/{eventId}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/schedule/{eventId}
  • Auth
    none declared

Path parameters

eventIdinteger required

The Scheduled Event ID

Request body application/x-www-form-urlencoded

eventTypeIdinteger required

The Event Type Id to use for this Event. * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action

campaignIdinteger

The Campaign ID to use for this Event. * If a Layout is needed then the Campaign specific ID for that Layout should be used.

commandIdinteger

The Command ID to use for this Event.

mediaIdinteger

The Media ID to use for this Event.

displayOrderinteger required

The display order for this event.

isPriorityinteger required

An integer indicating the priority of this event. Normal events have a priority of 0.

displayGroupIdsinteger[] required

The Display Group IDs for this event. * Display specific Group IDs should be used to schedule on single displays.

dayPartIdinteger

The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.

syncTimezoneinteger

Should this schedule be synced to the resulting Display timezone?

fromDtstring date-time required

The from date for this event.

toDtstring date-time

The to date for this event.

recurrenceType'' | 'Minute' | 'Hour' | 'Day' | 'Week' | 'Month' | 'Year'

The type of recurrence to apply to this event.

recurrenceDetailinteger

The interval for the recurrence.

recurrenceRangestring date-time

The end date for this events recurrence.

recurrenceRepeatsOninteger[]

The days of the week that this event repeats - weekly only

isGeoAwareinteger

Flag (0-1), whether this event is using Geo Location

geoLocationstring[]

Array of comma separated strings each with comma separated pair of coordinates

geoLocationJsonstring

Valid GeoJSON string, use as an alternative to geoLocation parameter

actionTypestring

For Action eventTypeId, the type of the action - command or navLayout

actionTriggerCodestring

For Action eventTypeId, the webhook trigger code for the Action

actionLayoutCodestring

For Action eventTypeId and navLayout actionType, the Layout Code identifier

dataSetIdinteger

For Data Connector eventTypeId, the DataSet ID

dataSetParamsstring

For Data Connector eventTypeId, the DataSet params

Response

successful operation

eventIdinteger

The ID of this Event

eventTypeIdinteger

The Event Type ID

campaignIdinteger

The CampaignID this event is for

commandIdinteger

The CommandId this event is for

userIdinteger

The userId that owns this event.

fromDtinteger

A Unix timestamp representing the from date of this event in CMS time.

toDtinteger

A Unix timestamp representing the to date of this event in CMS time.

isPriorityinteger

Integer indicating the event priority.

displayOrderinteger

The display order for this event.

recurrenceType'None' | 'Minute' | 'Hour' | 'Day' | 'Week' | 'Month' | 'Year'

If this event recurs when what is the recurrence period.

recurrenceDetailinteger

If this event recurs when what is the recurrence frequency.

recurrenceRangeinteger

A Unix timestamp indicating the end time of the recurring events.

recurrenceRepeatsOnstring

Recurrence repeats on days - 0 to 7 where 0 is a monday

recurrenceMonthlyRepeatsOninteger

Recurrence monthly repeats on - 0 is day of month, 1 is weekday of week

campaignstring

The Campaign/Layout Name

commandstring

The Command Name

dayPartIdinteger

The Day Part Id

isAlwaysinteger

Is this event an always on event?

isCustominteger

Does this event have custom from/to date times?

syncEventinteger

Flag indicating whether the event should be synchronised across displays

syncTimezoneinteger

Flag indicating whether the event will sync to the Display timezone

shareOfVoiceinteger

Seconds (0-3600) of each full hour that is scheduled that this Layout should occupy

maxPlaysPerHourinteger

The maximum number of plays per hour per display for this event

isGeoAwareinteger

Flag (0-1), whether this event is using Geo Location

geoLocationstring

Geo JSON representing the area of this event

actionTriggerCodestring

For Action event type, Action trigger code

actionTypestring

For Action event type, the type of the Action (navigate to Layout or Command)

actionLayoutCodestring

For Action event type and navigate to Layout Action type, the Layout code

parentCampaignIdinteger

If the schedule should be considered part of a larger campaign

syncGroupIdinteger

For sync events, the id the the sync group

dataSetIdinteger

For data connector events, the dataSetId

dataSetParamsinteger

For data connector events, the data set parameters

modifiedByinteger

The userId of the user that last modified this Schedule

createdOnstring

The Date this Schedule was created on

updatedOnstring

The Date this Schedule was las updated on

namestring

The name of this Scheduled Event

resolutionIdinteger

The resolutionId of this Fullscreen Scheduled Event

layoutDurationinteger

The duration of this Fullscreen Scheduled Event

backgroundColorstring

The background color of this Fullscreen Scheduled Event

Changes

    • info

      added the optional property // to the response with the status

    • breaking

      added required request body

    • info

      added the media type application/json for the response with the status