REST ClientFabricSWML Scripts

update

View as MarkdownOpen in Claude

Replace a SWML script resource. Uses PUT for full replacement.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a SWML Script.

Request

Update Calling ScriptobjectRequired
Request body to update an existing calling SWML Script. All fields are optional — include only what you want to change.
OR
Update Messaging ScriptobjectRequired
Request body to update an existing messaging SWML Script. All fields are optional — include only what you want to change.

Response

idstringRequiredformat: "uuid"
Unique ID of the SWML Script.
project_idstringRequiredformat: "uuid"
Unique ID of the Project.
display_namestringRequired
Display name of the SWML Script Fabric Resource
typeenumRequired
Type of the Fabric Resource
created_atdatetimeRequired
Date and time when the resource was created.
updated_atdatetimeRequired
Date and time when the resource was updated.
swml_scriptobjectRequired
SWML Script data.

Response Example

Response
1{
2  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
3  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
4  "display_name": "Welcome Script",
5  "type": "swml_script",
6  "created_at": "2024-05-06T12:20:00Z",
7  "updated_at": "2024-05-06T12:20:00Z",
8  "swml_script": {
9    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10    "display_name": "Booking Assistant",
11    "script_type": "calling",
12    "request_url": "https://example.com/swml_script",
13    "contents": {
14      "version": "1.0.0",
15      "sections": {
16        "main": [
17          {
18            "denoise": {},
19            "play": {
20              "url": "https://cdn.signalwire.com/swml/audio.mp3"
21            }
22          }
23        ]
24      }
25    },
26    "status_callback_url": "https://website.com/status",
27    "status_callback_method": "POST"
28  }
29}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9updated = client.fabric.swml_scripts.update("resource-id", display_name="updated-name")
10print(f"Updated: {updated['display_name']}")