> 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 cXML application PUT https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/cxml_applications/{id} Content-Type: application/json Changes where a cXML Application sends voice and messaging requests and callbacks. Compatibility [Update application](/docs/compatibility-api/rest/applications/update-application) manages the same application by Application SID; use whichever identifier your integration holds. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). Reference: https://signalwire.com/docs/apis/rest/cxml-applications/update-cxml-application ## 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 - `id` (string, required) — Unique ID of a cXML Application. ### Body (application/json) This endpoint expects a CxmlApplicationUpdateRequest. - `display_name` (string, optional) — Display name of the cXML Application - `account_sid` (string, optional) — Project ID for the cXML Application - `voice_url` (string, optional) — URL to handle incoming calls - `voice_method` (enum, optional) — HTTP method for voice URL - Allowed values: `GET`, `POST` - `voice_fallback_url` (string, optional) — Fallback URL for voice errors - `voice_fallback_method` (enum, optional) — HTTP method for voice fallback URL - Allowed values: `GET`, `POST` - `status_callback` (string, optional) — URL to receive status callbacks - `status_callback_method` (enum, optional) — HTTP method for status callbacks - Allowed values: `GET`, `POST` - `sms_url` (string, optional) — URL to handle incoming messages - `sms_method` (enum, optional) — HTTP method for SMS URL - Allowed values: `GET`, `POST` - `sms_fallback_url` (string, optional) — Fallback URL for SMS errors - `sms_fallback_method` (enum, optional) — HTTP method for SMS fallback URL - Allowed values: `GET`, `POST` - `sms_status_callback` (string, optional) — URL to receive SMS status callbacks - `sms_status_callback_method` (enum, optional) — HTTP method for SMS status callbacks - Allowed values: `GET`, `POST` ## Response ### 200 The request has succeeded. - `id` (string, required) — Unique ID of the cXML Application. - `project_id` (string, required) — Unique ID of the Project. - `display_name` (string, required) — Display name of the cXML Application Fabric Resource - `type` (enum, required) — Type of the Fabric Resource - Allowed values: `cxml_application` - `created_at` (datetime, required) — Date and time when the resource was created. - `updated_at` (datetime, required) — Date and time when the resource was updated. - `cxml_application` (CxmlApplication, required) — cXML Application data. ## Errors ### 401 Unauthorized Error Access is unauthorized. - `error` (enum, required) - Allowed values: `Unauthorized` ### 404 Not Found Error The server cannot find the requested resource. - `error` (enum, required) - Allowed values: `Not Found` ### 422 Unprocessable Entity Error The request contains invalid parameters. See errors for details. - `errors` (list of Types.StatusCodes.RestApiErrorItem, required) — List of validation errors. ### 500 Internal Server Error An internal server error occurred. - `error` (enum, required) - Allowed values: `Internal Server Error` ## Types ### CxmlApplication - `id` (string, required) — Unique ID of the cXML Application. - `project_id` (string, required) — Project ID for the cXML Application - `friendly_name` (string, required) — Display name of the cXML Application - `voice_url` (string, required, nullable) — URL to handle incoming calls - `voice_method` (enum, required) — HTTP method for voice URL - Allowed values: `GET`, `POST` - `voice_fallback_url` (string, required, nullable) — Fallback URL for voice errors - `voice_fallback_method` (enum, required) — HTTP method for voice fallback URL - Allowed values: `GET`, `POST` - `status_callback` (string, required, nullable) — URL to receive status callbacks - `status_callback_method` (enum, required) — HTTP method for status callbacks - Allowed values: `GET`, `POST` - `sms_url` (string, required, nullable) — URL to handle incoming messages - `sms_method` (enum, required) — HTTP method for SMS URL - Allowed values: `GET`, `POST` - `sms_fallback_url` (string, required, nullable) — Fallback URL for SMS errors - `sms_fallback_method` (enum, required) — HTTP method for SMS fallback URL - Allowed values: `GET`, `POST` - `sms_status_callback` (string, required, nullable) — URL to receive SMS status callbacks - `sms_status_callback_method` (enum, required) — HTTP method for SMS status callbacks - Allowed values: `GET`, `POST` ### Types.StatusCodes.RestApiErrorItem Details about a specific error. - `type` (string, required) — The category of error. - `code` (string, required) — A specific error code. - `message` (string, required) — A description of what caused the error. - `url` (string, required) — A link to documentation about this error. - `attribute` (string, optional, nullable) — The request parameter that caused the error, if applicable. ## Examples **Request** ```json {} ``` **Response** ```json { "id": "993ed018-9e79-4e50-b97b-984bd5534095", "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780", "display_name": "Reception App", "type": "cxml_application", "created_at": "2024-05-06T12:20:00Z", "updated_at": "2024-05-06T12:20:00Z", "cxml_application": { "id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780", "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780", "friendly_name": "Reception App", "voice_url": "https://example.com/voice/incoming", "voice_method": "GET", "voice_fallback_url": "https://example.com/voice/fallback", "voice_fallback_method": "GET", "status_callback": "https://example.com/voice/status", "status_callback_method": "GET", "sms_url": "https://example.com/message/incoming", "sms_method": "GET", "sms_fallback_url": "https://example.com/message/fallback", "sms_fallback_method": "GET", "sms_status_callback": "https://example.com/message/status", "sms_status_callback_method": "GET" } } ``` **SDK Code** ```python import requests url = "https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications/id" payload = {} headers = { "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers, auth=("", "")) print(response.json()) ``` ```javascript const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications/id'; const credentials = btoa(":"); const options = { method: 'PUT', headers: { Authorization: `Basic ${credentials}`, 'Content-Type': 'application/json' }, body: '{}' }; 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" "strings" "net/http" "io" ) func main() { url := "https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications/id" payload := strings.NewReader("{}") req, _ := http.NewRequest("PUT", url, payload) req.SetBasicAuth("", "") req.Header.Add("Content-Type", "application/json") 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_name}.signalwire.com/api/fabric/resources/cxml_applications/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request.basic_auth("", "") request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications/id") .basicAuth("", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('PUT', 'https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications/id', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications/id"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.PUT); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = [ "Authorization": "Basic \(credentials)", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data 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() ```