POST
/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.jsonUpdate a conference participant
Updates configurable properties of a participant in a conference. Use AccountSid, ConferenceSid, and CallSid to identify the participant, then supply the form fields for the settings you want to change. If Coaching is true, provide CallSidToCoach.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
AccountSidstringrequired
The account SID that created the participant resource. Must be 34 characters and match the `AC` SID format.
ConferenceSidstringrequired
The SID of the conference containing the participant. Must be 34 characters and match the `CF` SID format.
CallSidstringrequired
The participant's call SID or label. Percent-encode characters in a label that are not URL-safe.
Optional form-encoded participant settings to update.
Mutedbooleanoptional
Whether the participant should be muted. Can be `true` or `false`. `true` will mute the participant, and `false` will un-mute them. Anything value other than `true` or `false` is interpreted as `false`.
Holdbooleanoptional
Whether the participant should be on hold. Can be: `true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference.
HoldUrlstringoptional
The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.
HoldMethodstringoptional
The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`.
AnnounceUrlstringoptional
The URL we call using the `announce_method` for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.
AnnounceMethodstringoptional
The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`.
WaitUrlstringoptional
The URL that Twilio calls using the `wait_method` before the conference has started. The URL may return an MP3 file, a WAV file, or a TwiML document. The default value is the URL of our standard hold music. If you do not want anything to play while waiting for the conference to start, specify an empty string by setting `wait_url` to `''`. For more details on the allowable verbs within the `waitUrl`, see the `waitUrl` attribute in the [<Conference> TwiML instruction](https://www.twilio.com/docs/voice/twiml/conference#attributes-waiturl).
WaitMethodstringoptional
The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.
BeepOnExitbooleanoptional
Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`.
EndConferenceOnExitbooleanoptional
Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.
Coachingbooleanoptional
Whether the participant is coaching another call. Can be: `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.
CallSidToCoachstringoptional
The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.
200Returns the updated participant object, including its call and conference identifiers, coaching and hold settings, call status, timestamps, and resource URI.
account_sidstringoptional
The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resource.
call_sidstringoptional
The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Participant resource is associated with.
labelstringoptional
The user-specified label of this participant, if one was given when the participant was created. This may be used to fetch, update or delete the participant.
call_sid_to_coachstringoptional
The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.
coachingbooleanoptional
Whether the participant is coaching another call. Can be: `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_sidstringoptional
The SID of the conference the participant is in.
date_createdstringoptional
The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updatedstringoptional
The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
end_conference_on_exitbooleanoptional
Whether the conference ends when the participant leaves. Can be: `true` or `false` and the default is `false`. If `true`, the conference ends and all other participants drop out when the participant leaves.
mutedbooleanoptional
Whether the participant is muted. Can be `true` or `false`.
holdbooleanoptional
Whether the participant is on hold. Can be `true` or `false`.
start_conference_on_enterbooleanoptional
Whether the conference starts when the participant joins the conference, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.
statusstringoptional
The status of the participant's call in a session. Can be: `queued`, `connecting`, `ringing`, `connected`, `complete`, or `failed`.
queue_timestringoptional
The wait time in milliseconds before participant's call is placed. Only available in the response to a create participant request.
uristringoptional
The URI of the resource, relative to `https://api.twilio.com`.
Error handling
The AccountSid path parameter must be a 34-character account SID beginning with AC, and the ConferenceSid path parameter must be a 34-character conference SID beginning with CF. CallSid must identify the participant by call SID or label; percent-encode non-URL-safe characters in a label. HoldMethod, AnnounceMethod, and WaitMethod must each be GET or POST; if Coaching is true, provide a CallSidToCoach in the 34-character CA SID format.