Document dynamic audio and add a schedule response example

2026-09-11 18:45:59 -05:00
parent ec826093eb
commit c19c13b192
2 changed files with 25 additions and 6 deletions
@@ -107,10 +107,12 @@ Authenticates with the paired `email` + `licenseKey` query parameters and
 validates only that the key belongs to the account (not that the license is
 active/entitled). Returns the user's Blocks with start/end times and the IDs of
 the selected Proclamations (content is fetched separately via
-`/api/v2/proclamations`). Overnight blocks (end clock time before start) are
-supported and flagged with `overnight: true` plus a wrapping `durationMinutes`.
-Rate limited to 10 requests per minute per IP. Failure messages follow the
-existing v2 shape:
+`/api/v2/proclamations`). Each block also carries `dynamicAudio`; when true, the
+kiosk enables dynamic audio for the block's duration, overriding any audio
+selections made on the device while the block is active. Overnight blocks (end
+clock time before start) are supported and flagged with `overnight: true` plus a
+wrapping `durationMinutes`. Rate limited to 10 requests per minute per IP.
+Failure messages follow the existing v2 shape:
 `not-authorized` or `this key doesn't appear to belong to you`.

 ---