Skip to navigation
ReferenceAPI Referenceworkflows

Patch Workflow

Partially update a workflow — only supplied fields are changed.

Any combination of name, description, and definition may be included; omitted fields are left unchanged. At least one field must be present (empty body returns 422). If definition is provided it is fully validated; an invalid graph returns 422. Requires at least editor role.

Use PUT when replacing the full workflow definition in one operation.

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.
namestring or nullOptional1-200 characters

New workflow name (1–200 characters). Omit to leave unchanged.

descriptionstring or nullOptional<=5000 characters

New description (max 5000 characters). Omit to leave unchanged; pass null to clear.

definitionobject or nullOptional

Replacement graph and execution config. Omit to leave unchanged; must be valid if supplied.

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error