# Update a Participant

POST https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}
Content-Type: application/x-www-form-urlencoded

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

Reference: https://signalwire.com/docs/compatibility-api/rest/conference-participants/update-participant

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: compatibility
  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:
            type: string
            format: uuid
        - name: ConferenceSid
          in: path
          description: The unique identifier for the conference this participant is in.
          required: true
          schema:
            type: string
            format: uuid
        - name: CallSid
          in: path
          description: >-
            The unique identifier for the Participant call connected to this
            conference.
          required: true
          schema:
            type: string
            format: uuid
        - name: Authorization
          in: header
          description: >-
            SignalWire Basic Authentication using Project ID and API Token.


            The client sends HTTP requests with the Authorization header
            containing

            the word Basic followed by a space and a base64-encoded string of
            project_id:token.

            The project ID will be used as the username and the API token as the
            password.


            Example:

            ```

            Authorization: Basic base64(project_id:token)

            ```
          required: true
          schema:
            type: string
      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:
    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
          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:
          type: string
          format: 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'
          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'
          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:
          type: string
          format: uuid
          description: The unique identifier for the account that created this conference.
        call_sid:
          type: string
          format: uuid
          description: >-
            The unique identifier for the Participant call connected to this
            conference.
        call_sid_to_coach:
          type:
            - string
            - 'null'
          format: uuid
          description: The unique identifier of the participant who is being coached.
        coaching:
          type: boolean
          description: Whether the participant is coaching another call.
        conference_sid:
          type: string
          format: 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
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of
        project_id:token.

        The project ID will be used as the username and the API token as the
        password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid"

payload = ""
headers = {
    "Authorization": "Basic <project_id>:<api_token>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <project_id>:<api_token>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams('')
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'
request["Content-Type"] = 'application/x-www-form-urlencoded'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid', [
  'form_params' => null,
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
    'Content-Type' => 'application/x-www-form-urlencoded',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Basic <project_id>:<api_token>",
  "Content-Type": "application/x-www-form-urlencoded"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```