v1

latestOpenAPI 3.0.42026-08-06124112344.5 KB

Templates

Create a new module/zone within a template. Modules/zones define rectangular content areas where playlist content is displayed.

post/templates/{templateId}/modules

templateIdstring required

Template Id

namestring nullable

Module/zone name (descriptive identifier)

typestring nullable

Module/zone type (e.g., 'Playlist', 'Clock', 'Weather', 'Ticker', 'Web')

leftinteger nullable

Left position

topinteger nullable

Top position

widthinteger nullable

Width

heightinteger nullable

Height

playlist_idstring nullable

Playlist assigned to this module

sequenceinteger nullable

Sequence or Z-Order

Returns the newly-created module/zone

idstring nullable

Module/zone unique identifier

namestring nullable

Module/zone name

typestring nullable

Module/zone type (e.g., 'Playlist', 'Clock', 'Weather', 'Ticker', 'Web')

leftinteger nullable

Left position in pixels from the top-left corner of the template

topinteger nullable

Top position in pixels from the top-left corner of the template

widthinteger nullable

Width of the module/zone in pixels

heightinteger nullable

Height of the module/zone in pixels

playlist_idstring nullable

Playlist ID assigned to this module/zone. Determines what content is displayed in this area of the screen.

sequenceinteger nullable

Sequence or Z-order for overlapping modules/zones. Higher values appear in front of lower values.