Update a Participant

Allows you to modify the properties of participant in an active conference call.

Permissions

The API token must include the following scopes: Voice.

Path Parameters
AccountSid uuid — REQUIRED The unique identifier for the account that created this conference.
ConferenceSid uuid — REQUIRED The unique identifier for the conference this participant is in.
CallSid uuid — REQUIRED The unique identifier for the Participant call connected to this conference.

Request Body — REQUIRED
AnnounceUrl string The URL to send participant announcements to.
AnnounceMethod string Possible values: [GET, POST] Whether the request to AnnounceUrl is a GET or a POST. Default is POST.
Beep boolean Whether or not ot play the beep sound when updating the Participant.
Coaching boolean Whether the participant is coaching another call. Possible values are true or false. If not present, defaults to false unless call_sid_to_coach is defined. If true, call_sid_to_coach must be defined.
CallSidToCoach uuid The unique identifier of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.
Hold boolean Whether or not a participant is on hold. Possible values are true or false.
HoldMethod string Possible values: [GET, POST] Whether the request to HoldUrl is a GET or a POST. Default is POST.
HoldUrl string The URL to send hold music to that will be played when participant is on hold.
Muted boolean Whether or not a participant is muted. Possible values are true or false.

Responses

200 OK Schema — OPTIONAL account_sid uuid — OPTIONAL The unique identifier for the account that created this conference. call_sid uuid — OPTIONAL The unique identifier for the Participant call connected to this conference. call_sid_to_coach uuid — OPTIONAL The unique identifier of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching. coaching boolean — OPTIONAL Whether the participant is coaching another call. Possible values are true or false. If not present, defaults to false unless call_sid_to_coach is defined. If true, call_sid_to_coach must be defined. conference_sid uuid — OPTIONAL The unique identifier for the conference this participant is in. date_created string — OPTIONAL The date, in RFC 2822 format, this conference participant was created. status string — OPTIONAL Possible values: [completed, in-progress] The status of the conference call (?) date_updated string — OPTIONAL The date, in RFC 2822 format, this conference participant was updated. end_conference_on_exit boolean — OPTIONAL Whether or not a conference ends when a participant leaves the conference call. Possible values are true or false. muted boolean — OPTIONAL Whether or not a participant is muted. Possible values are true or false. hold boolean — OPTIONAL Whether or not a participant is on hold. Possible values are true or false. start_conference_on_enter boolean — OPTIONAL Whether or not a conference will begin when this participant enters the conference call. Possible values are true or false. uri string — OPTIONAL The URI for this conference participant.