Update SWML Script

PUT

https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts/:id

PUT

/api/fabric/resources/swml_scripts/:id

curl -X PUT https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts/id \
     -H "Content-Type: application/json" \
     -u "<project_id>:<api_token>" \
     -d '{
  "contents": {
    "sections": {
      "main": [
        {
          "reply": "Thanks for your message!"
        }
      ]
    },
    "version": "1.0.0"
  },
  "display_name": "Updated Reply Bot",
  "script_type": "calling"
}'

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Reply Bot",
  "type": "swml_script",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:25:00Z",
  "swml_script": {
    "contents": {
      "sections": {
        "main": [
          {
            "reply": "Thanks for your message!"
          }
        ]
      },
      "version": "1.0.0"
    },
    "display_name": "Reply Bot",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "request_url": "https://example.com/swml_script",
    "script_type": "messaging"
  }
}

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.

Changes a stored SWML Script while preserving the same Fabric resource and addresses. Use [Update SWML webhook](/docs/apis/rest/swml-webhook/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](/docs/platform/your-signalwire-api-space).

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)

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.

Update Calling ScriptobjectRequired

Request body to update an existing calling SWML Script. All fields are optional — include only what you want to change.

Update Messaging ScriptobjectRequired

Request body to update an existing messaging SWML Script. All fields are optional — include only what you want to change.

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

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

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error