Sign in
Conference Participants

Update a Participant

Changes an active voice-conference participant's mute, hold, coaching, wait-audio, or announcement settings by Call SID. Use Update Conference to end or announce to the entire conference, and delete the participant to remove only that caller.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

post/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The unique identifier for the account that created this conference.

ConferenceSidstring uuid required

Universal Unique Identifier.

The unique identifier for the conference this participant is in.

CallSidstring uuid required

Universal Unique Identifier.

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

Response

The request has succeeded.

account_sidstring uuid required

Universal Unique Identifier.

call_sidstring uuid required

Universal Unique Identifier.

call_sid_to_coachstring uuid required

Universal Unique Identifier.

coachingboolean required

Whether the participant is coaching another call.

conference_sidstring uuid required

Universal Unique Identifier.

date_createdstring required

The date, in RFC 2822 format, this conference participant was created.

status'completed' | 'in-progress' required

Conference participant status.

date_updatedstring required

The date, in RFC 2822 format, this conference participant was updated.

end_conference_on_exitboolean required

Whether or not a conference ends when a participant leaves the conference call.

mutedboolean required

Whether or not a participant is muted.

holdboolean required

Whether or not a participant is on hold.

start_conference_on_enterboolean required

Whether or not a conference will begin when this participant enters the conference call.

uristring required

The URI for this conference participant.

Example response

{
  "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
  "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
  "start_conference_on_enter": true,
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants/b3877c40-da60-4998-90ad-b792e98472ca.json"
}

Changes

Changed in 8 of the 40 revisions of this API.18137

  • 2916d5e3072e56See the full diff
    • ▲

      added to the request property allOf list

      request-property-all-of-added

    • ▲

      the response's property type changed from string to no type, and format from uuid to no format for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type, and format from uuid to no format for status

      response-property-type-changed

    • ▲

      the response's property format changed from uuid to no format for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to no type, and format from uuid to no format for status

      response-property-type-changed

    • ○

      the request property type was generalized from string to no type, and format from uuid to no format

      request-property-type-generalized

    • ○

      added to the response property allOf list for the response status

      response-property-all-of-added

    • ○

      added to the response property allOf list for the response status

      response-property-all-of-added

    • ○

      added to the response property allOf list for the response status

      response-property-all-of-added

    • ○

      added to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      removed subschema #1 from the response property anyOf list for the response status

      response-property-any-of-removed

  • 5344c0c93a4c15See the full diff
    • ▲

      added 'unevaluatedProperties' constraint to the request body

      request-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status

      response-body-unevaluated-properties-added

  • 2e516ba2383f1See the full diff
    • ▲

      response property call_sid_to_coach list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

  • d5fbaaddfa3e3118See the full diff
    • ▲

      the request property format changed from no format to uri

      request-property-type-changed

    • ▲

      the request property format changed from no format to uri

      request-property-type-changed

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ●

      removed the request property

      request-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      the request property default value changed from POST to GET

      request-property-default-value-changed

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 07f73f74a61d11See the full diff
    • ▲

      removed the media type application/json from the request body

      request-body-media-type-removed

    • ○

      added the media type application/x-www-form-urlencoded to the request body

      request-body-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6b2611cfa74b1See the full diff
    • ▲

      the request property became not nullable

      request-property-became-not-nullable

  • 686ef84c2abc11See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

  • 3c88f14db21e56See the full diff
    • ▲

      added the new path request parameter AccountSid

      new-request-path-parameter

    • ▲

      added the new path request parameter CallSid

      new-request-path-parameter

    • ▲

      added the new path request parameter ConferenceSid

      new-request-path-parameter

    • ▲

      removed the media type application/x-www-form-urlencoded from the request body

      request-body-media-type-removed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ○

      added the media type application/json to the request body

      request-body-media-type-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added to the response property allOf list for the response status

      response-property-all-of-added

    • ○

      removed the completed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the in-progress enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog