Publish players
publish_playersPublish a content snapshot to one or all players, making each screen reflect its current content assignment. Use after updating playlists or when a publish is required.
Instructions
Build a fresh content snapshot so one or every player picks up its current content assignment.
When to use:
update_player returned publish_required: true.
The user changed a playlist's items elsewhere and asks to make screens reflect it.
When NOT to use:
For a single field-only rename — that takes effect immediately without publish.
What to know:
Omit player_id to publish every player in the tenant. Per-player failures are returned in "failed" without aborting the batch.
Players with no playlist/sequence/planning assigned are listed under "skipped" with reason "no_content_assigned".
Snapshots are durable; the player pulls them on its next heartbeat (typically within 10 seconds).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| player_id | No | Specific player to publish; omit to publish every player |