# Update cXML Application PUT https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/cxml_applications/{id} Content-Type: application/json Updates a cXML Application by ID #### 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/fabric/cxml-applications/update-cxml-application ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: fabric version: 1.0.0 paths: /resources/cxml_applications/{id}: put: operationId: update-cxml-application summary: Update cXML Application description: >- Updates a cXML Application by ID #### 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). tags: - subpackage_cxmlApplications parameters: - name: id in: path description: Unique ID of a cXML Application. required: true schema: $ref: '#/components/schemas/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/CxmlApplicationResponse' '401': description: Access is unauthorized. content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode401' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode404' '422': description: The request contains invalid parameters. See errors for details. content: application/json: schema: $ref: '#/components/schemas/CxmlApplicationUpdateStatusCode422' '500': description: An internal server error occurred. content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode500' requestBody: content: application/json: schema: $ref: '#/components/schemas/CxmlApplicationUpdateRequest' servers: - url: https://%7BYour_Space_Name%7D.signalwire.com/api/fabric components: schemas: uuid: type: string format: uuid description: Universal Unique Identifier. title: uuid CxmlApplicationUpdateRequestVoiceMethod0: type: string enum: - GET title: CxmlApplicationUpdateRequestVoiceMethod0 CxmlApplicationUpdateRequestVoiceMethod1: type: string enum: - POST title: CxmlApplicationUpdateRequestVoiceMethod1 CxmlApplicationUpdateRequestVoiceMethod: oneOf: - $ref: '#/components/schemas/CxmlApplicationUpdateRequestVoiceMethod0' - $ref: '#/components/schemas/CxmlApplicationUpdateRequestVoiceMethod1' description: HTTP method for voice URL title: CxmlApplicationUpdateRequestVoiceMethod CxmlApplicationUpdateRequestVoiceFallbackMethod0: type: string enum: - GET title: CxmlApplicationUpdateRequestVoiceFallbackMethod0 CxmlApplicationUpdateRequestVoiceFallbackMethod1: type: string enum: - POST title: CxmlApplicationUpdateRequestVoiceFallbackMethod1 CxmlApplicationUpdateRequestVoiceFallbackMethod: oneOf: - $ref: >- #/components/schemas/CxmlApplicationUpdateRequestVoiceFallbackMethod0 - $ref: >- #/components/schemas/CxmlApplicationUpdateRequestVoiceFallbackMethod1 description: HTTP method for voice fallback URL title: CxmlApplicationUpdateRequestVoiceFallbackMethod CxmlApplicationUpdateRequestStatusCallbackMethod0: type: string enum: - GET title: CxmlApplicationUpdateRequestStatusCallbackMethod0 CxmlApplicationUpdateRequestStatusCallbackMethod1: type: string enum: - POST title: CxmlApplicationUpdateRequestStatusCallbackMethod1 CxmlApplicationUpdateRequestStatusCallbackMethod: oneOf: - $ref: >- #/components/schemas/CxmlApplicationUpdateRequestStatusCallbackMethod0 - $ref: >- #/components/schemas/CxmlApplicationUpdateRequestStatusCallbackMethod1 description: HTTP method for status callbacks title: CxmlApplicationUpdateRequestStatusCallbackMethod CxmlApplicationUpdateRequestSmsMethod0: type: string enum: - GET title: CxmlApplicationUpdateRequestSmsMethod0 CxmlApplicationUpdateRequestSmsMethod1: type: string enum: - POST title: CxmlApplicationUpdateRequestSmsMethod1 CxmlApplicationUpdateRequestSmsMethod: oneOf: - $ref: '#/components/schemas/CxmlApplicationUpdateRequestSmsMethod0' - $ref: '#/components/schemas/CxmlApplicationUpdateRequestSmsMethod1' description: HTTP method for SMS URL title: CxmlApplicationUpdateRequestSmsMethod CxmlApplicationUpdateRequestSmsFallbackMethod0: type: string enum: - GET title: CxmlApplicationUpdateRequestSmsFallbackMethod0 CxmlApplicationUpdateRequestSmsFallbackMethod1: type: string enum: - POST title: CxmlApplicationUpdateRequestSmsFallbackMethod1 CxmlApplicationUpdateRequestSmsFallbackMethod: oneOf: - $ref: '#/components/schemas/CxmlApplicationUpdateRequestSmsFallbackMethod0' - $ref: '#/components/schemas/CxmlApplicationUpdateRequestSmsFallbackMethod1' description: HTTP method for SMS fallback URL title: CxmlApplicationUpdateRequestSmsFallbackMethod CxmlApplicationUpdateRequestSmsStatusCallbackMethod0: type: string enum: - GET title: CxmlApplicationUpdateRequestSmsStatusCallbackMethod0 CxmlApplicationUpdateRequestSmsStatusCallbackMethod1: type: string enum: - POST title: CxmlApplicationUpdateRequestSmsStatusCallbackMethod1 CxmlApplicationUpdateRequestSmsStatusCallbackMethod: oneOf: - $ref: >- #/components/schemas/CxmlApplicationUpdateRequestSmsStatusCallbackMethod0 - $ref: >- #/components/schemas/CxmlApplicationUpdateRequestSmsStatusCallbackMethod1 description: HTTP method for SMS status callbacks title: CxmlApplicationUpdateRequestSmsStatusCallbackMethod CxmlApplicationUpdateRequest: type: object properties: display_name: type: string description: Display name of the cXML Application account_sid: $ref: '#/components/schemas/uuid' description: Project ID for the cXML Application voice_url: type: string description: URL to handle incoming calls voice_method: $ref: '#/components/schemas/CxmlApplicationUpdateRequestVoiceMethod' description: HTTP method for voice URL voice_fallback_url: type: string description: Fallback URL for voice errors voice_fallback_method: $ref: '#/components/schemas/CxmlApplicationUpdateRequestVoiceFallbackMethod' description: HTTP method for voice fallback URL status_callback: type: string description: URL to receive status callbacks status_callback_method: $ref: >- #/components/schemas/CxmlApplicationUpdateRequestStatusCallbackMethod description: HTTP method for status callbacks sms_url: type: string description: URL to handle incoming messages sms_method: $ref: '#/components/schemas/CxmlApplicationUpdateRequestSmsMethod' description: HTTP method for SMS URL sms_fallback_url: type: string description: Fallback URL for SMS errors sms_fallback_method: $ref: '#/components/schemas/CxmlApplicationUpdateRequestSmsFallbackMethod' description: HTTP method for SMS fallback URL sms_status_callback: type: string description: URL to receive SMS status callbacks sms_status_callback_method: $ref: >- #/components/schemas/CxmlApplicationUpdateRequestSmsStatusCallbackMethod description: HTTP method for SMS status callbacks title: CxmlApplicationUpdateRequest CxmlApplicationResponseType: type: string enum: - cxml_application description: Type of the Fabric Resource title: CxmlApplicationResponseType CxmlApplicationVoiceMethod0: type: string enum: - GET title: CxmlApplicationVoiceMethod0 CxmlApplicationVoiceMethod1: type: string enum: - POST title: CxmlApplicationVoiceMethod1 CxmlApplicationVoiceMethod: oneOf: - $ref: '#/components/schemas/CxmlApplicationVoiceMethod0' - $ref: '#/components/schemas/CxmlApplicationVoiceMethod1' description: HTTP method for voice URL title: CxmlApplicationVoiceMethod CxmlApplicationVoiceFallbackMethod0: type: string enum: - GET title: CxmlApplicationVoiceFallbackMethod0 CxmlApplicationVoiceFallbackMethod1: type: string enum: - POST title: CxmlApplicationVoiceFallbackMethod1 CxmlApplicationVoiceFallbackMethod: oneOf: - $ref: '#/components/schemas/CxmlApplicationVoiceFallbackMethod0' - $ref: '#/components/schemas/CxmlApplicationVoiceFallbackMethod1' description: HTTP method for voice fallback URL title: CxmlApplicationVoiceFallbackMethod CxmlApplicationStatusCallbackMethod0: type: string enum: - GET title: CxmlApplicationStatusCallbackMethod0 CxmlApplicationStatusCallbackMethod1: type: string enum: - POST title: CxmlApplicationStatusCallbackMethod1 CxmlApplicationStatusCallbackMethod: oneOf: - $ref: '#/components/schemas/CxmlApplicationStatusCallbackMethod0' - $ref: '#/components/schemas/CxmlApplicationStatusCallbackMethod1' description: HTTP method for status callbacks title: CxmlApplicationStatusCallbackMethod CxmlApplicationSmsMethod0: type: string enum: - GET title: CxmlApplicationSmsMethod0 CxmlApplicationSmsMethod1: type: string enum: - POST title: CxmlApplicationSmsMethod1 CxmlApplicationSmsMethod: oneOf: - $ref: '#/components/schemas/CxmlApplicationSmsMethod0' - $ref: '#/components/schemas/CxmlApplicationSmsMethod1' description: HTTP method for SMS URL title: CxmlApplicationSmsMethod CxmlApplicationSmsFallbackMethod0: type: string enum: - GET title: CxmlApplicationSmsFallbackMethod0 CxmlApplicationSmsFallbackMethod1: type: string enum: - POST title: CxmlApplicationSmsFallbackMethod1 CxmlApplicationSmsFallbackMethod: oneOf: - $ref: '#/components/schemas/CxmlApplicationSmsFallbackMethod0' - $ref: '#/components/schemas/CxmlApplicationSmsFallbackMethod1' description: HTTP method for SMS fallback URL title: CxmlApplicationSmsFallbackMethod CxmlApplicationSmsStatusCallbackMethod0: type: string enum: - GET title: CxmlApplicationSmsStatusCallbackMethod0 CxmlApplicationSmsStatusCallbackMethod1: type: string enum: - POST title: CxmlApplicationSmsStatusCallbackMethod1 CxmlApplicationSmsStatusCallbackMethod: oneOf: - $ref: '#/components/schemas/CxmlApplicationSmsStatusCallbackMethod0' - $ref: '#/components/schemas/CxmlApplicationSmsStatusCallbackMethod1' description: HTTP method for SMS status callbacks title: CxmlApplicationSmsStatusCallbackMethod CxmlApplication: type: object properties: id: $ref: '#/components/schemas/uuid' description: Unique ID of the cXML Application. project_id: $ref: '#/components/schemas/uuid' description: Project ID for the cXML Application friendly_name: type: string description: Display name of the cXML Application voice_url: type: - string - 'null' description: URL to handle incoming calls voice_method: $ref: '#/components/schemas/CxmlApplicationVoiceMethod' description: HTTP method for voice URL voice_fallback_url: type: - string - 'null' description: Fallback URL for voice errors voice_fallback_method: $ref: '#/components/schemas/CxmlApplicationVoiceFallbackMethod' description: HTTP method for voice fallback URL status_callback: type: - string - 'null' format: uri description: URL to receive status callbacks status_callback_method: $ref: '#/components/schemas/CxmlApplicationStatusCallbackMethod' description: HTTP method for status callbacks sms_url: type: - string - 'null' description: URL to handle incoming messages sms_method: $ref: '#/components/schemas/CxmlApplicationSmsMethod' description: HTTP method for SMS URL sms_fallback_url: type: - string - 'null' description: Fallback URL for SMS errors sms_fallback_method: $ref: '#/components/schemas/CxmlApplicationSmsFallbackMethod' description: HTTP method for SMS fallback URL sms_status_callback: type: - string - 'null' description: URL to receive SMS status callbacks sms_status_callback_method: $ref: '#/components/schemas/CxmlApplicationSmsStatusCallbackMethod' description: HTTP method for SMS status callbacks required: - id - project_id - friendly_name - voice_url - voice_method - voice_fallback_url - voice_fallback_method - status_callback - status_callback_method - sms_url - sms_method - sms_fallback_url - sms_fallback_method - sms_status_callback - sms_status_callback_method title: CxmlApplication CxmlApplicationResponse: type: object properties: id: $ref: '#/components/schemas/uuid' description: Unique ID of the cXML Application. project_id: $ref: '#/components/schemas/uuid' description: Unique ID of the Project. display_name: type: string description: Display name of the cXML Application Fabric Resource type: $ref: '#/components/schemas/CxmlApplicationResponseType' description: Type of the Fabric Resource created_at: type: string format: date-time description: Date and time when the resource was created. updated_at: type: string format: date-time description: Date and time when the resource was updated. cxml_application: $ref: '#/components/schemas/CxmlApplication' description: cXML Application data. required: - id - project_id - display_name - type - created_at - updated_at - cxml_application title: CxmlApplicationResponse TypesStatusCodesStatusCode401Error: type: string enum: - Unauthorized title: TypesStatusCodesStatusCode401Error Types.StatusCodes.StatusCode401: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error' required: - error description: Access is unauthorized. title: Types.StatusCodes.StatusCode401 TypesStatusCodesStatusCode404Error: type: string enum: - Not Found title: TypesStatusCodesStatusCode404Error Types.StatusCodes.StatusCode404: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error' required: - error description: The server cannot find the requested resource. title: Types.StatusCodes.StatusCode404 Types.StatusCodes.RestApiErrorItem: type: object properties: type: type: string description: The category of error. code: type: string description: A specific error code. message: type: string description: A description of what caused the error. attribute: type: - string - 'null' description: The request parameter that caused the error, if applicable. url: type: string description: A link to documentation about this error. required: - type - code - message - url description: Details about a specific error. title: Types.StatusCodes.RestApiErrorItem CxmlApplicationUpdateStatusCode422: type: object properties: errors: type: array items: $ref: '#/components/schemas/Types.StatusCodes.RestApiErrorItem' description: List of validation errors. required: - errors description: The request contains invalid parameters. See errors for details. title: CxmlApplicationUpdateStatusCode422 TypesStatusCodesStatusCode500Error: type: string enum: - Internal Server Error title: TypesStatusCodesStatusCode500Error Types.StatusCodes.StatusCode500: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error' required: - error description: An internal server error occurred. title: Types.StatusCodes.StatusCode500 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_name}.signalwire.com/api/fabric/resources/cxml_applications/id" payload = {} headers = { "Authorization": "Basic :", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications/id'; const options = { method: 'PUT', headers: { Authorization: 'Basic :', '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.Header.Add("Authorization", "Basic :") 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["Authorization"] = 'Basic :' 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") .header("Authorization", "Basic :") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('PUT', 'https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications/id', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Basic :', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications/id"); var request = new RestRequest(Method.PUT); request.AddHeader("Authorization", "Basic :"); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Basic :", "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() ```