> 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 Script
PUT https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/cxml_scripts/{id}
Content-Type: application/json
Changes a stored cXML Script while preserving its Fabric resource and addresses. The change is also visible through Compatibility [Update a cXML Script](/docs/compatibility-api/rest/cxml-scripts/update-cxml-script), which manages the same script by LamlBin SID. Use [Update cXML webhook](/docs/apis/rest/cxml-webhook/update-cxml-webhook) for a server-backed handler.
#### 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-scripts/update-cxml-script
## 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 Script.
### Body (application/json)
This endpoint expects a CXMLScriptUpdateRequest.
- `display_name` (string, optional) — Display name of the cXML Script
- `contents` (string, optional) — The cXML script contents
- `status_callback_url` (string, optional) — URL to send status callbacks to
- `status_callback_method` (enum, optional) — HTTP method to use for status callbacks
- Allowed values: `GET`, `POST`
## Response
### 200
The request has succeeded.
- `id` (string, required) — Unique ID of the cXML Script.
- `project_id` (string, required) — Unique ID of the Project.
- `name` (string, required) — Display name of the cXML Script Fabric Resource
- `type` (enum, required) — Type of the Fabric Resource
- Allowed values: `cxml_script`
- `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_script` (CXMLScript, required) — cXML Script 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
### CXMLScript
- `id` (string, required) — Unique ID of a cXML Script.
- `contents` (string, required) — The cXML script contents
- `request_count` (integer, required) — The amout of times the cXML script has been requested
- `last_accessed_at` (datetime, required, nullable) — The date and time when the cXML script was last accessed
- `request_url` (string, required) — The URL where the cXML script can be accessed
- `script_type` (enum, required) — The script type the cXML Script is used for
- Allowed values: `calling`, `messaging`
- `display_name` (string, required) — Display name of the cXML Script Fabric Resource
- `status_callback_url` (string, optional, nullable) — The url that will send status updates for the cXML Script
- `status_callback_method` (enum, optional) — HTTP method for status callback URL
- 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",
"name": "Reception Script",
"type": "cxml_script",
"created_at": "2024-05-06T12:20:00Z",
"updated_at": "2024-05-06T12:20:00Z",
"cxml_script": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"contents": "Hello World",
"request_count": 5,
"last_accessed_at": "2023-10-01T12:00:00Z",
"request_url": "https://example.signalwire.com/laml-bins/2537c89e-2606-48c2-b3c2-bb601d863d1e",
"script_type": "calling",
"display_name": "Booking Assistant Script",
"status_callback_url": "https://example.com/cxml/status",
"status_callback_method": "POST"
}
}
```
**SDK Code**
```python
import requests
url = "https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_scripts/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_scripts/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_scripts/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_scripts/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_scripts/id")
.basicAuth("", "")
.header("Content-Type", "application/json")
.body("{}")
.asString();
```
```php
request('PUT', 'https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_scripts/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_scripts/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_scripts/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()
```