Deploy call flow version

View as MarkdownOpen in Claude
Deploys a specific version of a Call Flow. #### 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) ```

Path parameters

idstringRequired
The unique identifier of the Call Flow.

Request

This endpoint expects an object.
Deploy by document versionobjectRequired
OR
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_dataobject
Call Flow Builder state, stored as an opaque JSON object.
relaymlobject

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