Skip to navigation
ReferenceAPI Referenceworkflows

Update Workflow

Replace a workflow’s name, description, and definition (full update).

All fields in the request body are required. The definition is validated before persisting; an invalid graph returns 422. Existing runs are not affected — each run captures a definition_snapshot at start time. Requires at least editor role. Use PATCH to update only specific fields without supplying the full definition.

Authentication

AuthorizationBearer
Clerk JWT token
OR
AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Path parameters

workflow_idstringRequiredformat: "uuid"

Headers

X-Workspace-Idstring or nullOptional

Request

This endpoint expects an object.
namestringRequired1-200 characters

Human-readable workflow name (1–200 characters, non-blank).

definitionobjectRequired
Full replacement graph and execution config. Must be valid.
descriptionstring or nullOptional<=5000 characters

Optional description (max 5000 characters). Pass null to clear.

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error