Update a Participant

POST 
/Accounts/:AccountSid/Conferences/:ConferenceSid/Participants/:CallSid

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

Permissions

The API token must include the following scopes: Voice.

Request

Path Parameters

AccountSid uuidrequired

The unique identifier for the account that created this conference.

ConferenceSid uuidrequired

The unique identifier for the conference this participant is in.

CallSid uuidrequired

The unique identifier for the Participant call connected to this conference.

application/x-www-form-urlencoded

Body

required

AnnounceUrlstring

The URL to send participant announcements to.

AnnounceMethodstring
Whether the request to AnnounceUrl is a GET or a POST. Default is POST.
Possible values: [GET, POST]
Example: POST
Beepboolean

Whether or not ot play the beep sound when updating the Participant.

Coachingboolean
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.
Example: false
CallSidToCoachuuid

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.

Holdboolean

Whether or not a participant is on hold. Possible values are true or false.

HoldMethodstring
Whether the request to HoldUrl is a GET or a POST. Default is POST.
Possible values: [GET, POST]
Example: POST
HoldUrlstring

The URL to send hold music to that will be played when participant is on hold.

Mutedboolean

Whether or not a participant is muted. Possible values are true or false.

Responses

200

OK

application/json

Schema

Schema

account_siduuid

The unique identifier for the account that created this conference.

call_siduuid

The unique identifier for the Participant call connected to this conference.

call_sid_to_coachuuid

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.

coachingboolean
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.
Example: false
conference_siduuid

The unique identifier for the conference this participant is in.

date_createdstring
The date, in RFC 2822 format, this conference participant was created.
Example: Mon, 24 Sept 2018 21:00:00 +0000
statusstring

The status of the conference call (?)

Possible values: [completed, in-progress]

date_updatedstring
The date, in RFC 2822 format, this conference participant was updated.
Example: Tue, 25 Sept 2018 20:00:00 +0000
end_conference_on_exitboolean

Whether or not a conference ends when a participant leaves the conference call. Possible values are true or false.

mutedboolean

Whether or not a participant is muted. Possible values are true or false.

holdboolean

Whether or not a participant is on hold. Possible values are true or false.

start_conference_on_enterboolean

Whether or not a conference will begin when this participant enters the conference call. Possible values are true or false.

uristring
The URI for this conference participant.
Example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472pa/Participants/b3877c40-da60-4998-90ad-b792e98472ca.json

Example (from schema)

{
  "account_sid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "call_sid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "call_sid_to_coach": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "coaching": false,
  "conference_sid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
  "status": "completed",
  "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
  "end_conference_on_exit": true,
  "muted": true,
  "hold": true,
  "start_conference_on_enter": true,
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472pa/Participants/b3877c40-da60-4998-90ad-b792e98472ca.json"
}