Update a playlist
update_playlistEdit an EXISTING playlist: rename/describe it, set its play window, toggle shuffle, append items, remove items, patch item duration/fit, or reorder. Compose any subset in one call; each change runs through the same validation as the CMS editor. Steps run in this order: details, removals, item edits, appends, reorder; if one step fails, the earlier ones stay applied. An edit can send an approved playlist back to draft when its location requires approval; the response returns the final playlist with its approvalState. Get item ids with get_playlist; to create new playlists use bulk_create. Requires playlist.edit at the playlist's node.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New display name. | |
| shuffle | No | true plays the items in random order; false in list order. | |
| startsAt | No | ISO datetime the playlist starts airing; null clears. | |
| expiresAt | No | ISO datetime the playlist stops airing; null clears. | |
| fullscreen | No | When this playlist plays inside a layout, EVERY item fills the whole screen and the other zones hide. Per-item: patchItems[].fullscreen. | |
| patchItems | No | Changes to existing items, max 50 per call. Only the fields given change. | |
| playlistId | Yes | Playlist to edit (pl_…), from list_items kind playlists. | |
| appendItems | No | Items to add at the end of the playlist, in order, max 50 per call. | |
| description | No | New note about the playlist, shown in the console. | |
| removeItemIds | No | Item ids (pli_…) to remove, max 50 per call. An id that is already gone is ignored. | |
| reorderItemIds | No | The COMPLETE item order after the move — unknown ids are dropped, the rest keep this sequence. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||