Docs
REST API v1

Remove a participant

View as MarkdownEdit on GitHub

Disconnect one participant and remove their live media resources.

DELETE/v1/rooms/{roomId}/participants/{participantId}

Requirements

A secret API key with participants:remove. Resources are restricted to the key's project and environment.

Path parameters

NameTypeRequired / defaultDescription
roomIdstringRequiredID of a room in the key's environment.
participantIdstringRequiredID of a participant in this room.

Example

Set RELAYRTC_API_URL to your API base including /v1, such as http://localhost:8082/v1.

Shell
curl -X DELETE "$RELAYRTC_API_URL/rooms/room_example/participants/participant_example" \
  -H "Authorization: Bearer $RELAYRTC_SECRET_KEY"

Response

204 when removal is complete. 202 with a runtime operation when cleanup is pending.

JSON
{
  "id": "operation_example",
  "kind": "participant.remove",
  "status": "pending",
  "attempts": 0,
  "lastError": null,
  "completedAt": null
}

Notes

This disconnects the participant

Removal affects the participant’s live session and tracks. Use this operation for moderation or administrative removal.

Errors

Invalid fields return 400. Invalid credentials return 401; a missing scope returns 403. A missing resource returns 404. See error responses.