Skip to main content
PATCH
Update a workflow

Authorizations

Authorization
string
header
required

Secret key (sk_live_...)

Headers

Idempotency-Key
string

Optional key that makes the request idempotent. Retrying with the same key returns the original response instead of repeating the operation; keys expire after 24 hours. Any string up to 256 characters. See Idempotency.

Maximum string length: 256
Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

workflow_id
string
required

Unique identifier for the workflow (prefixed with wflo_).

Pattern: ^wflo_
Example:

"wflo_AbC123xYz456"

Body

Request body for updating a workflow. Omit a field to leave it unchanged. Edits apply to future runs only.

name
null | string

New display name.

Maximum string length: 255
steps
null | object[]

Replacement step definitions. The array is replaced wholesale, not merged.

Minimum array length: 1

One step of a workflow definition, discriminated by type.

Response

OK

Workflow definition object.

id
string
required

Unique identifier for the workflow, prefixed with wflo_.

Pattern: ^wflo_
Example:

"wflo_AbC123xYz456"

object
string
required

Always workflow.

name
string
required

Display name.

steps
object[]
required

Ordered array of step definitions.

One step of a workflow definition, discriminated by type.

created_at
string<date-time>
required
Example:

"2026-06-18T00:00:00Z"

updated_at
string<date-time>
required
Example:

"2026-06-18T00:00:00Z"

request_id
string

Unique identifier for the API request. Include this when contacting support.