Stop room playback
Stop every active playback in this room. You can call this endpoint when no playback is active; it still accepts the stop command.
The 202 response confirms that the platform accepted the stop command; it does not confirm that playback has ended. Its operation_uuid identifies this stop command.
Webhook: If this command interrupts active playback, the platform emits room.playback.ended with reason: stopped. If a file was playing, the platform also emits room.playback.file.ended with reason: stopped. Both events identify the interrupted playback in operation_uuid, not this stop command. No webhook is emitted for the 202 admission or when no playback is active.
See Room lifecycle, participant, and playback events for complete payload schemas and examples.
Authentication
Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.
Path parameters
Case-sensitive room identifier.
Headers
Optional key for safely retrying mutating requests. An explicitly empty header is treated like omission and does not enable replay protection. See Idempotency for details.
optional client-supplied lowercase RFC-4122 v4 UUID returned as operation_uuid; platform generates one when omitted; correlation metadata distinct from Idempotency-Key.
Request
Response headers
Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. A valid incoming traceparent is linked to, but never becomes, the server-owned trace identifier.