> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt

# updateParticipant

> Update a participant in a conference (mute or hold).

Update a participant in a conference (e.g., mute or hold).

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}:
    post:
      operationId: update-participant
      summary: Update a Participant
      description: >-
        Update a participant.


        #### 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](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_conferenceParticipants
      parameters:
        - name: AccountSid
          in: path
          description: The unique identifier for the account that created this conference.
          required: true
          schema:
            $ref: '#/components/schemas/uuid'
        - name: ConferenceSid
          in: path
          description: The unique identifier for the conference this participant is in.
          required: true
          schema:
            $ref: '#/components/schemas/uuid'
        - name: CallSid
          in: path
          description: >-
            The unique identifier for the Participant call connected to this
            conference.
          required: true
          schema:
            $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceParticipantResponse'
        '400':
          description: >-
            The request was invalid or cannot be processed. Check the error
            details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '404':
          description: >-
            The requested resource was not found. Please verify the resource
            identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '422':
          description: >-
            The request could not be processed due to validation errors. Check
            the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConferenceParticipantRequest'
servers:
  - url: https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
components:
  schemas:
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    UpdateConferenceParticipantRequestAnnounceMethod:
      type: string
      enum:
        - GET
        - POST
      default: POST
      description: >-
        Whether the request to `AnnounceUrl` is a `GET` or a `POST`. Default is
        `POST`.
      title: UpdateConferenceParticipantRequestAnnounceMethod
    UpdateConferenceParticipantRequestHoldMethod:
      type: string
      enum:
        - GET
        - POST
      default: GET
      description: >-
        Whether the request to `HoldUrl` is a `GET` or a `POST`. Default is
        `GET`.
      title: UpdateConferenceParticipantRequestHoldMethod
    UpdateConferenceParticipantRequestWaitMethod:
      type: string
      enum:
        - GET
        - POST
      default: POST
      description: >-
        Whether the request to `WaitUrl` is a `GET` or a `POST`. Default is
        `POST`.
      title: UpdateConferenceParticipantRequestWaitMethod
    UpdateConferenceParticipantRequest:
      type: object
      properties:
        AnnounceUrl:
          type: string
          format: uri
          description: The URL to send conference announcements to.
        AnnounceMethod:
          $ref: >-
            #/components/schemas/UpdateConferenceParticipantRequestAnnounceMethod
          default: POST
          description: >-
            Whether the request to `AnnounceUrl` is a `GET` or a `POST`. Default
            is `POST`.
        Coaching:
          type: boolean
          description: >-
            Whether the participant is coaching another call. Requires
            `CallSidToCoach` to be set.
        CallSidToCoach:
          $ref: '#/components/schemas/uuid'
          description: >-
            The unique identifier of the participant who is being coached.
            Required when `Coaching` is true.
        Hold:
          type: boolean
          description: Whether or not a participant is on hold.
        HoldMethod:
          $ref: '#/components/schemas/UpdateConferenceParticipantRequestHoldMethod'
          default: GET
          description: >-
            Whether the request to `HoldUrl` is a `GET` or a `POST`. Default is
            `GET`.
        HoldUrl:
          type: string
          format: uri
          description: >-
            The URL to send hold music to that will be played when participant
            is on hold.
        Muted:
          type: boolean
          description: Whether or not a participant is muted.
        WaitUrl:
          type: string
          format: uri
          description: >-
            The URL for wait music to be played while a conference is not yet
            started.
        WaitMethod:
          $ref: '#/components/schemas/UpdateConferenceParticipantRequestWaitMethod'
          default: POST
          description: >-
            Whether the request to `WaitUrl` is a `GET` or a `POST`. Default is
            `POST`.
      description: Request body for updating a conference participant.
      title: UpdateConferenceParticipantRequest
    ParticipantStatus:
      type: string
      enum:
        - completed
        - in-progress
      description: Conference participant status.
      title: ParticipantStatus
    ConferenceParticipantResponse:
      type: object
      properties:
        account_sid:
          $ref: '#/components/schemas/uuid'
          description: The unique identifier for the account that created this conference.
        call_sid:
          $ref: '#/components/schemas/uuid'
          description: >-
            The unique identifier for the Participant call connected to this
            conference.
        call_sid_to_coach:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: The unique identifier of the participant who is being coached.
        coaching:
          type: boolean
          description: Whether the participant is coaching another call.
        conference_sid:
          $ref: '#/components/schemas/uuid'
          description: The unique identifier for the conference this participant is in.
        date_created:
          type: string
          description: >-
            The date, in RFC 2822 format, this conference participant was
            created.
        status:
          $ref: '#/components/schemas/ParticipantStatus'
          description: The status of the conference call.
        date_updated:
          type: string
          description: >-
            The date, in RFC 2822 format, this conference participant was
            updated.
        end_conference_on_exit:
          type: boolean
          description: >-
            Whether or not a conference ends when a participant leaves the
            conference call.
        muted:
          type: boolean
          description: Whether or not a participant is muted.
        hold:
          type: boolean
          description: Whether or not a participant is on hold.
        start_conference_on_enter:
          type: boolean
          description: >-
            Whether or not a conference will begin when this participant enters
            the conference call.
        uri:
          type: string
          description: The URI for this conference participant.
      required:
        - account_sid
        - call_sid
        - call_sid_to_coach
        - coaching
        - conference_sid
        - date_created
        - status
        - date_updated
        - end_conference_on_exit
        - muted
        - hold
        - start_conference_on_enter
        - uri
      description: Response containing a single conference participant.
      title: ConferenceParticipantResponse
    CompatibilityErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: Error code.
        message:
          type: string
          description: Error message.
        more_info:
          type: string
          description: URL for more information about the error.
        status:
          type: integer
          description: HTTP status code.
      required:
        - code
        - message
        - more_info
        - status
      description: Error response model.
      title: CompatibilityErrorResponse

```

## **Response Example**

### Response (200)

```json
{
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
  "call_sid": "b3877c40-da60-4998-90ad-b792e98472ca",
  "call_sid_to_coach": "b3877c40-da60-4998-90ad-b792e98472co",
  "coaching": false,
  "conference_sid": "b3877c40-da60-4998-90ad-b792e98472cf",
  "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": false,
  "muted": false,
  "hold": false,
  "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"
}
```

## **Example**

```typescript {9}
import { RestClient } from "@signalwire/sdk";

const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});

await client.compat.conferences.updateParticipant("CF...", "CA...", { Muted: true });
```