Sign in

v1

latestOpenAPI 3.1.02026-07-24474114.4 KB

Add a Page

add page to a playlist

post/playlists/{id}/pages

Path parameters

idstring required

id of a playlist

Headers

content-typestring

Request body

descriptionstring

field acts as a name of a page

durationinteger

specify certain amount of time for page to play

transitionstring

transition for playlist applies here

default_pageboolean
ignored_tagsstring[]

do not display on device that has tag

require_tagsstring[]

display on devices that have tag

daysstring[]

add days scheduling option to a page

hours_fromstring

add display hours option to a playlist, format "00:00:00"

hours_tostring

format "00:00:00"

startinteger

start date and time ,format "start":1581112800

endinteger

end date and time format "end":1581112800

auto_removeboolean

if true, page will be removed when time specified in "end" parameter comes

campaign_idstring

put adcapmaign ID here

backgroundstring

"bgType=custom&bgMedia=urlOfIImageHere&darkOverlay=false&zoomEffect=false&whiteText=true"

grid_templatestring

By default page has one zone, with this parameter you can define custom grid for a page

hoursstring

combine hours_from and hours_to into one string "00:00:00-01:02:00"

Response

200

created_atnumber
descriptionstring
grid_templatestring
idstring
playlist_idstring
priorityinteger
updated_atnumber

Example response

{
  "created_at": 1639485201.176,
  "description": "New Page",
  "grid_template": "{\"name\":\"default\",\"template\":\"\\\"main\\\" auto / auto\"}",
  "id": "61b88f11aa4a7e2464c3292f",
  "playlist_id": "5ff324ea966f638ffb3148f5",
  "priority": 6,
  "updated_at": 1639485201.176
}