Skip to navigation

Delete room

View as Markdown

Delete a room. Deletion disconnects all participants and stops room recording and playback.

A 202 Accepted response with {room_id, status: "deleting"} confirms that the asynchronous deletion request was accepted. Deletion is not yet complete.

Triggered webhook: The platform emits room.deleted with exactly one of these reasons:

  • reason: "closed" after room deletion is confirmed.
  • reason: "timeout" if confirmation does not arrive.

See Room lifecycle, participant, and playback events for complete payload schemas and examples.

Authentication

AuthorizationBearer

Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.

Path parameters

room_idstringRequired

Case-sensitive room identifier.

Headers

Idempotency-KeystringOptionalformat: "^[a-zA-Z0-9._-]*$"<=128 characters

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.

Response headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

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.

Response

Room deletion accepted
room_idstring
statusenum
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error
503
Service Unavailable Error