Skip to main content
PATCH
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Uniquely identifies the conference.

participant_id
string
required

Uniquely identifies the participant.

Body

application/json
end_conference_on_exit
boolean

Whether the conference should end when this participant exits.

Example:

false

soft_end_conference_on_exit
boolean

Whether the conference should soft-end when this participant exits. A soft end will stop new participants from joining but allow existing participants to remain.

Example:

false

beep_enabled
enum<string>

Whether entry/exit beeps are enabled for this participant.

Available options:
always,
never,
on_enter,
on_exit
Example:

"always"

Response

Successful response

data
Conference Participant · object