Skip to navigation

Update call flow

View as MarkdownOpen in Claude

Saves a new editable revision of a Call Flow in your SignalWire project. Supply the next required document_version and a new title: an update that omits title or resends the Call Flow’s current name is rejected. Omit flow_data or relayml to keep its current value. 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.

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 Call Flow.

Request

This endpoint expects an object.
titlestringRequired

The name of the Call Flow. Required on every update, and must not match the name of any Call Flow in the project, including this one. Omitting title or resending the current name is rejected with a 422.

document_versionintegerRequired

The revision number for this update. Must equal the Call Flow’s current document_version plus one; any other value is rejected with an out_of_sync error.

flow_dataobjectOptional

Call Flow Builder state, stored as an opaque JSON object. Omit to keep the current value; an empty object is rejected. If the Call Flow has no stored value yet, you must send one.

relaymlobjectOptional

The calling SWML document this Call Flow should execute. Uses calling SWML methods. Omit to keep the current document; an empty object is rejected. If the Call Flow has no stored document yet, you must send one.

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
Allowed values:
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

422
Unprocessable Entity Error
500
Internal Server Error