provider Api20100401Participant POST /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json
@utdk/twilio /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json
Update the properties of the participant
Update the properties of the participant
AccountSid path required
The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to update.
string
ConferenceSid path required
The SID of the conference with the participant to update.
string
CallSid path required
The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.
string

Try it

Authentication
Configure credentials for Twilio - Api
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

updateparticipant
POST/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json
Update the properties of the participant

Parameters

required

The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to update.

required

The SID of the conference with the participant to update.

required

The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.

Input

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`.

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.

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.

The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`.

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.

The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`.

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).

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.

Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`.

Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.

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.

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`.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import twilio from '@utdk/twilio';

await twilio.updateparticipant()