Update call flow

PUT

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

PUT

/api/fabric/resources/call_flows/:id

curl -X PUT https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows/id \
     -H "Content-Type: application/json" \
     -u "<project_id>:<api_token>" \
     -d '{
  "document_version": 2,
  "flow_data": {},
  "relayml": {
    "sections": {
      "main": [
        {
          "play": {
            "url": "https://cdn.signalwire.com/swml/audio.mp3"
          }
        }
      ]
    },
    "version": "1.0.0"
  },
  "title": "Updated Welcome Call Flow"
}'

{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Welcome Call Flow",
  "type": "call_flow",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:25:00Z",
  "call_flow": {
    "id": "993ed018-9e79-4e50-b97b-984bd5534095",
    "title": "Welcome Call Flow",
    "flow_data": {},
    "relayml": {
      "sections": {
        "main": [
          {
            "play": {
              "url": "https://cdn.signalwire.com/swml/audio.mp3"
            }
          }
        ]
      },
      "version": "1.0.0"
    },
    "document_version": 1
  }
}

Saves a new editable revision of a Call Flow in your SignalWire project. Supply the next required document_version, then make the saved revision live with Deploy call flow version. Directly authored SWML belongs in Update SWML Script.

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.

Saves a new editable revision of a Call Flow in your SignalWire project. Supply the next required `document_version`, then make the saved revision live with [Deploy call flow version](/docs/apis/rest/call-flows/deploy-call-flow-version). Directly authored SWML belongs in [Update SWML Script](/docs/apis/rest/swml-scripts/update-swml-script). #### 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 Call Flow.

Request

This endpoint expects an object.

document_versionintegerRequired

The current revision of the call flow. Must equal the call flow’s existing document_version + 1.

flow_dataobjectRequired

Call Flow Builder state, stored as an opaque JSON object.

relaymlobjectRequired

The calling SWML document this Call Flow should execute. Uses calling SWML methods.

titlestringOptional

The name of the Call Flow

Response

The request has succeeded.

idstringformat: "uuid"

Unique ID of the Call Flow.

project_idstringformat: "uuid"

Unique ID of the Project.

display_namestring

Display name of the Call Flow 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.

call_flowobject

Call Flow data.

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error