Schedules
Tools for managing schedules. A schedule defines time-based rules that determine when playlists, templates, or campaigns play on devices.
list_schedules
List all schedules in the account. Returns schedule objects with id, name, type, group assignment, and device targets.
| Parameter | Type | Required | Description |
|---|---|---|---|
group_id |
string | No | Filter by schedule group ID |
device_id |
string | No | Filter by target device ID |
take |
number | No | Results per page |
page |
number | No | Page number (1-based) |
get_schedule
Get a schedule by ID including its time entries and device assignments. Returns the schedule’s name, type (Playlist, Template, or Campaign), content reference, playback rules, and assigned device IDs.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | The schedule ID |
create_schedule
Create a new schedule linking content to devices with time-based playback rules.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string | Yes | Name for the new schedule |
group_id |
string | No | Schedule group ID |
type |
string | No | Content type: Playlist, Template, or Campaign |
is_shared |
boolean | No | Share across organizations |
Additional properties can be passed to configure time entries and device assignments.
update_schedule
Update a schedule’s properties, time entries, or device assignments. Only include fields you want to change.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | The schedule ID |
name |
string | No | Updated name |
group_id |
string | No | Move to this group |
type |
string | No | Updated content type |
is_shared |
boolean | No | Share across organizations |
delete_schedule
Permanently delete a schedule. Devices assigned to this schedule will no longer receive its content.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | The schedule ID |