Skip to navigation
EndpointsWorkflows

Create Workflow Version

Deploy a new version of a workflow. The deployed version becomes available for running workflow runs.

When steps is omitted, the current draft is deployed as-is. When steps is provided, the given steps are deployed directly without modifying the draft.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The ID of the workflow to deploy.

Headers

x-extend-api-version"2026-02-09"OptionalDefaults to 2026-02-09

API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.

Request

This endpoint expects an object.
namestringOptional
An optional name for this deployed version.
stepslist of objectsOptional

Optional step definitions. When provided, these steps are deployed directly without modifying the draft. When omitted, the current draft is deployed.

All configurable steps (EXTRACT, CLASSIFY, SPLIT, CONDITIONAL_EXTRACT, RULE_VALIDATION, EXTERNAL_DATA_VALIDATION) must include config when deploying. Unconfigured steps are rejected with a 400.

See the Configuring Workflows via API guide for step definitions, branching patterns, and examples.

Response

Version deployed successfully
objectenum

The type of object. Always "workflow_version".

Allowed values:
idstring
The ID of the workflow version.
versionstring

The version number as a string, or "draft" for the draft version.

namestring or null
The name of the workflow version.
stepslist of objects
The step definitions for this version.
createdAtstringformat: "date-time"

The time (in UTC) at which the object was created. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

createdByobject

The actor that created this resource.

  • user — the resource was created via the studio by a logged-in user. The user’s email is exposed.
  • api_key — the resource was created via the API using an API key. The key’s name is exposed.

May be null for resources created before attribution.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error