API ReferenceWorkflows

Clone a workflow

Creates a new workflow by cloning an existing one. Optionally clones into a different environment (sandbox or live) via the target_environment body field.

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

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

Response

Cloned workflow.
idstring
Workflow ID.
namestring

Human-readable workflow name.

versioninteger
Workflow version number, incremented on each update.
is_defaultboolean
Whether this is the organization's default workflow.
is_activeboolean
Whether this workflow is active and available for use.
created_atdatetime
descriptionstring or null
Optional description of what this workflow does.
step_countinteger
Number of steps in the workflow.
formatenumDefaults to steps

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

updated_atdatetime

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error