Deploy call flow version

POST

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

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.

Makes one saved Call Flow version active, selected by document version or version ID. Use it after updating a visual flow when that revision is ready to handle calls; updating the Call Flow saves a revision but does not replace this deployment step. Directly authored [SWML Scripts](/docs/apis/rest/swml-scripts/create-swml-script) do not use Call Flow versions. #### 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

idstringRequired

The unique identifier of the Call Flow.

Request

This endpoint expects an object.

Deploy by document versionobjectRequired

Deploy by version IDobjectRequired

Response

The request has succeeded and a new resource has been created as a result.

idstringformat: "uuid"

The unique identifier of the deployed Call Flow Version.

created_atstring

The creation timestamp.

updated_atstring

The last update timestamp.

document_versioninteger

The document version.

flow_dataobjectOptional

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

relaymlobjectOptional

The calling SWML document deployed by this version. Uses calling SWML methods.

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error