Clear Display
clear_displayRemoves the current live content from a display and returns it to its idle/default state. Viewers will immediately see the change. Use this when the user wants to blank or reset a display. This does not delete the display itself — use delete_display for that. Requires authentication with at least content_only scope. Returns id and status ('cleared').
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| display_id | Yes | The 8-character alphanumeric display profile ID to clear, e.g. 'ABCD1234'. | |
| access_token | No | Optional bearer token; prefer session_request_id. | |
| session_request_id | No | Session handle from create_auth_session; pass it on every authenticated call. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| status | No | ||
| currentContentDescription | No |