Skip to navigation
Resource ManagementSWML Scripts

Update SWML Script

View as MarkdownOpen in Claude

Changes a stored SWML Script while preserving the same Fabric resource and addresses. Use Update SWML webhook when the resource points to server-generated SWML instead.

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.

Authentication

AuthorizationBasic

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)

Path parameters

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

Request

This endpoint expects an object.
namestringOptional
Name of the SWML Script.
script_typeenumOptional
The kind of script. Omit to keep the script's current type.
Allowed values:
contentsmap from strings to any or stringOptional

The SWML document, as a JSON object or as a string of JSON or YAML. A Calling Script uses calling SWML methods; a Messaging Script uses messaging SWML methods.

status_callback_urlstringOptionalformat: "uri"
URL that receives status callbacks for messages sent or calls made by this script.

Response

The request has succeeded.
idstringformat: "uuid"
Unique ID of the SWML Script.
project_idstringformat: "uuid"
Unique ID of the Project.
display_namestring
Display name of the SWML Script Fabric Resource
typeenum
Type of the Fabric Resource
Allowed values:
created_atdatetime
Date and time when the resource was created.
updated_atdatetime
Date and time when the resource was updated.
swml_scriptobject
SWML Script data.

Errors

422
Unprocessable Entity Error
500
Internal Server Error