Templates
Tools for managing templates. A template is a multi-zone layout that defines content areas on the screen — each zone can display a different playlist, web page, or media item simultaneously. Templates also support JavaScript scripting for interactive or dynamic content.
list_templates
List all templates in the account. Returns template objects with id, name, group assignment, and zone configuration.
| Parameter | Type | Required | Description |
|---|---|---|---|
group_id |
string or string[] | No | Filter by template group ID(s) |
group_name |
string or string[] | No | Filter by template group name(s) |
take |
number | No | Results per page |
page |
number | No | Page number (1-based) |
get_template
Get a template by ID including its full zone definitions and scripting. Returns the template’s name, dimensions, group, and an array of zones where each zone defines a screen region with position, size, and content assignment.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | The template ID |
create_template
Create a new template (multi-zone layout). At minimum a name is required.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string | Yes | Name for the new template |
group_id |
string | No | Template group ID |
width |
number | No | Canvas width in pixels (e.g. 1920) |
height |
number | No | Canvas height in pixels (e.g. 1080) |
update_template
Update a template’s properties, zone layout, or scripting. When modifying zones, send the complete zones array — it replaces existing zones entirely.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | The template ID |
name |
string | No | Updated name |
group_id |
string | No | Move to this group |
width |
number | No | Updated canvas width |
height |
number | No | Updated canvas height |