API ReferenceWorkflows

Publish a workflow draft

Promotes a draft into a new published workflow version with the specified initial rollout percentage.

Required scope: workflows:write

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

workflow_idstringRequired
draft_idstringRequired

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Key-InflectionenumOptionalDefaults to snake

Response key casing. Defaults to snake.

Allowed values:
Idempotency-KeystringOptional<=255 characters

Unique key for idempotent requests. Cached for 24 hours. Sending the same key with different parameters returns 422.

Request

This endpoint expects an object.
initial_rollout_percentageintegerRequired0-100

Response

Draft published.
created_atdatetime
idstring
Workflow ID.
is_activeboolean
Whether this workflow is active and available for use.
is_defaultboolean
Whether this is the organization's default workflow.
namestring

Human-readable workflow name.

versioninteger
Workflow version number, incremented on each update.
descriptionstring or null
Optional description of what this workflow does.
formatenumDefaults to steps

Workflow format — “steps” for legacy array format, “graph” for DAG format.

published_versioninteger
step_countinteger
Number of steps in the workflow.
updated_atdatetime

Errors

401
Unauthorized Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error