Skip to main content
PATCH
/
conferences
/
{id}
/
participants
/
{participant_id}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.conferences.updateParticipant('participant_id', {
  id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

console.log(response.data);
{
  "data": {
    "id": "<string>",
    "call_control_id": "<string>",
    "call_leg_id": "<string>",
    "conference_id": "<string>",
    "label": "<string>",
    "status": "joining",
    "muted": true,
    "on_hold": true,
    "whisper_call_control_ids": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "end_conference_on_exit": true,
    "soft_end_conference_on_exit": true
  }
}

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