> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # 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 Changes an active voice-conference participant's mute, hold, coaching, wait-audio, or announcement settings by Call SID. Use [Update Conference](/docs/compatibility-api/rest/conferences/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](/docs/platform/your-signalwire-api-space). Reference: https://signalwire.com/docs/compatibility-api/rest/conference-participants/update-participant ## Authentication - `Authorization` header (basic auth, required) — 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) ``` ## Request ### Path parameters - `AccountSid` (string, required) — The unique identifier for the account that created this conference. - `ConferenceSid` (string, required) — The unique identifier for the conference this participant is in. - `CallSid` (string, required) — The unique identifier for the Participant call connected to this conference. ### Body (application/x-www-form-urlencoded) This endpoint expects an UpdateConferenceParticipantRequest. - `AnnounceUrl` (string, optional) — The URL to send conference announcements to. - `AnnounceMethod` (enum, optional, default: POST) — Whether the request to `AnnounceUrl` is a `GET` or a `POST`. Default is `POST`. - Allowed values: `GET`, `POST` - `Coaching` (boolean, optional) — Whether the participant is coaching another call. Requires `CallSidToCoach` to be set. - `CallSidToCoach` (string, optional) — The unique identifier of the participant who is being coached. Required when `Coaching` is true. - `Hold` (boolean, optional) — Whether or not a participant is on hold. - `HoldMethod` (enum, optional, default: GET) — Whether the request to `HoldUrl` is a `GET` or a `POST`. Default is `GET`. - Allowed values: `GET`, `POST` - `HoldUrl` (string, optional) — The URL to send hold music to that will be played when participant is on hold. - `Muted` (boolean, optional) — Whether or not a participant is muted. - `WaitUrl` (string, optional) — The URL for wait music to be played while a conference is not yet started. - `WaitMethod` (enum, optional, default: POST) — Whether the request to `WaitUrl` is a `GET` or a `POST`. Default is `POST`. - Allowed values: `GET`, `POST` ## Response ### 200 The request has succeeded. - `account_sid` (string, required) — The unique identifier for the account that created this conference. - `call_sid` (string, required) — The unique identifier for the Participant call connected to this conference. - `call_sid_to_coach` (string, required, nullable) — The unique identifier of the participant who is being coached. - `coaching` (boolean, required) — Whether the participant is coaching another call. - `conference_sid` (string, required) — The unique identifier for the conference this participant is in. - `date_created` (string, required) — The date, in RFC 2822 format, this conference participant was created. - `status` (enum, required) — The status of the conference call. - Allowed values: `completed`, `in-progress` - `date_updated` (string, required) — The date, in RFC 2822 format, this conference participant was updated. - `end_conference_on_exit` (boolean, required) — Whether or not a conference ends when a participant leaves the conference call. - `muted` (boolean, required) — Whether or not a participant is muted. - `hold` (boolean, required) — Whether or not a participant is on hold. - `start_conference_on_enter` (boolean, required) — Whether or not a conference will begin when this participant enters the conference call. - `uri` (string, required) — The URI for this conference participant. ## Errors ### 400 Bad Request Error The request was invalid or cannot be processed. Check the error details for more information. - `code` (integer, required) — Error code. - `message` (string, required) — Error message. - `more_info` (string, required) — URL for more information about the error. - `status` (integer, required) — HTTP status code. ### 401 Unauthorized Error Authentication failed. Please verify your credentials and try again. - `code` (integer, required) — Error code. - `message` (string, required) — Error message. - `more_info` (string, required) — URL for more information about the error. - `status` (integer, required) — HTTP status code. ### 404 Not Found Error The requested resource was not found. Please verify the resource identifier. - `code` (integer, required) — Error code. - `message` (string, required) — Error message. - `more_info` (string, required) — URL for more information about the error. - `status` (integer, required) — HTTP status code. ### 422 Unprocessable Entity Error The request could not be processed due to validation errors. Check the error details for more information. - `code` (integer, required) — Error code. - `message` (string, required) — Error message. - `more_info` (string, required) — URL for more information about the error. - `status` (integer, required) — HTTP status code. ## Examples **Request** ```json {} ``` **Response** ```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" } ``` **SDK Code** ```python import requests url = "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid" payload = "" headers = { "Content-Type": "application/x-www-form-urlencoded" } response = requests.post(url, data=payload, headers=headers, auth=("", "")) print(response.json()) ``` ```javascript const url = 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid'; const credentials = btoa(":"); const options = { method: 'POST', headers: { Authorization: `Basic ${credentials}`, '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.SetBasicAuth("", "") 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.basic_auth("", "") 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 response = Unirest.post("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid") .basicAuth("", "") .header("Content-Type", "application/x-www-form-urlencoded") .asString(); ``` ```php request('POST', 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid', [ 'form_params' => null, 'headers' => [ 'Content-Type' => 'application/x-www-form-urlencoded', ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Conferences/ConferenceSid/Participants/CallSid"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/x-www-form-urlencoded"); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = [ "Authorization": "Basic \(credentials)", "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() ```