Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

workflow_id
string<uuid>
required

The unique id of the workflow

Body

application/json

At least one field must be present. Fields you omit are left unchanged.

name
string

The new workflow name.

Required string length: 1 - 120
Example:

"Loan follow-up v2"

settings
object

A JSON merge patch (RFC 7396) onto the workflow's stored settings. Objects merge key by key, a key you omit is left unchanged, and null removes one. The merged result is validated as a whole, and unknown keys are rejected.

Example:

Response

Workflow updated. Header values in settings are returned masked.

id
string<uuid>
required

Unique workflow id.

name
string
required

Display name.

status
enum<string>
required

Workflow status.

Available options:
active,
archived
latest_published_version
integer | null

Number of the newest published version, or null if nothing is published yet.

created_at
string<date-time>
updated_at
string<date-time>
settings
object

The workflow's live settings. Header values are always returned as **********.