Update player
update_playerChange a player's name, orientation, or content assignments (playlist, sequence, planning, group). Pass null to unassign; publish afterwards to apply.
Instructions
Patch mutable fields on a single player.
When to use:
The user wants to rename a player, change its orientation, or reassign content.
When NOT to use:
For content authoring — playlists, sequences, and planning have their own dedicated tools (coming in v0.2.0).
What to know:
Mutable fields: name, orientation ("landscape" | "portrait" | "portrait-reverse"), playlist_id, sequence_id, planning_id, group_id.
Assigning a *_id schedules a publish — the response includes publish_required: true. Call publish_players to make the player actually pick up the change.
Pass null to clear an assignment (e.g. playlist_id: null).
Exactly one of playlist_id / sequence_id / planning_id may be non-null at a time.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| group_id | No | ||
| player_id | Yes | ||
| orientation | No | ||
| planning_id | No | ||
| playlist_id | No | ||
| sequence_id | No |