Kick a user from the document

Designing

Staging

POST

/internal/documents/{roomId}/kick

Documents

Forcibly disconnects a user's WebSocket connection to the Yjs document.
Called by the control-plane when a participant is kicked from the room
(DELETE /rooms/:roomId/participants/:userId).

The user's WebSocket is closed with code 4002 (Kicked) and an optional reason message.

Request

Authorization

API Key

Add parameter in header

X-Internal-Secret

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

User kicked (or was not connected)

Body

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/internal/documents//kick' \
--header 'X-Internal-Secret: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userId": "660e8400-e29b-41d4-a716-446655440001",
    "reason": "Removed by host"
}'

Response Example

200 - Example 1

{
    "kicked": true
}

Modified at 2026-03-11 21:59:03

Destroy a Yjs document

Health check