Update room state

Designing

Staging

POST

/internal/documents/{roomId}/state

Documents

Updates the authoritative room phase and editor lock state for an existing document.
Called by the control-plane after room phase transitions or editor lock changes.

The collab-plane stores the latest values and broadcasts them to connected clients
via room-state events.

Request

Authorization

API Key

Add parameter in header

X-Internal-Secret

Example:

X-Internal-Secret: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Room state updated

Body

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/internal/documents//state' \
--header 'X-Internal-Secret: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "roomId": "550e8400-e29b-41d4-a716-446655440000",
    "phase": "waiting",
    "editorLocked": true
}'

Response Example

200 - Example 1

{
    "success": true
}

Modified at 2026-04-09 21:45:10

Toggle editor lock

Health check