Skip to main content
PATCH
Update workflow metadata. Only the fields you supply are touched — omit a field to leave it unchanged.

Authorizations

Authorization
string
header
required

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

Path Parameters

workflow_id
string
required

Body

application/json

Body for updating a workflow. Only the supplied fields (name, description) are changed.

name
string | null

The name of the workflow

Maximum string length: 200
description
string | null

Description of the workflow

Maximum string length: 4000

Response

Successful Response

A workflow and its current configuration.

id
string
required

Unique ID for this workflow

created_at
string<date-time>
required
updated_at
string<date-time>
required
name
string
default:Untitled Workflow

The name of the workflow

description
string
default:""

Description of the workflow

project_id
string | null

Project that owns this workflow. Null only on legacy rows that predate the project backfill.

published
WorkflowPublished · object | null

Published workflow metadata when a published version exists