Skip to main content
PATCH
Edit a workflow draft

Authorizations

Authorization
string
header
required

An API key (utk_live_...) or an app's OAuth access token (uto_...).

Headers

Idempotency-Key
string

Any 1 to 255 printable ASCII characters, without a space at either end. The answer to the first request with a key is kept for 24 hours per credential: the same request again gets it back (Idempotent-Replayed: true), another request with the key is 409 PUB-002-002, and while the first still runs 409 PUB-002-003. A server error is not kept, and a request that never answered frees its key after 2 minutes: a retry with the key then runs again.

Maximum string length: 255

Path Parameters

workflowId
string<uuid>
required

A workflow id.

Body

application/json

Send a name, a draft or both.

expectedDraftVersion
integer
required

draftVersion from the last read. Missing is 400 PUB-001-004.

Required range: x >= 0
name
string | null
Required string length: 1 - 200
draft
object | null

The whole new draft; it replaces the stored one.

Example:

Response

The workflow after the edit.

id
string<uuid>
required
name
string
required
status
enum<string>
required
Available options:
draft,
active,
disabled,
paused
hasUnpublishedChanges
boolean
required

The draft holds changes that don't run yet.

draftVersion
integer
required

Send it back as expectedDraftVersion on the next edit.

draft
object
required

The workflow as its editor holds it, at most 512 KB stored.

Example:
published
object | null
required

What runs now; null while the workflow was never published.

Example:
pausedReason
string | null
required
pausedAt
string<date-time> | null
required
Example:

"2026-09-30T10:00:00.000Z"

publishIssues
object[]
required

What a person must finish before publishing, each on its step (null for the trigger or the whole flow).

warnings
object[]
required

What publishing allows but the person should see.

editorUrl
string<uri>
required

Opens the workflow editor in Usertick, where a person publishes the workflow, which also turns it on.

draftUpdatedAt
string<date-time> | null
required
Example:

"2026-09-30T10:00:00.000Z"

createdAt
string<date-time>
required
Example:

"2026-09-30T10:00:00.000Z"

updatedAt
string<date-time> | null
required
Example:

"2026-09-30T10:00:00.000Z"

aiGenerated
boolean
required
aiGeneratedAt
string<date-time> | null
required

When text Usertick AI wrote was first stored here; null when people wrote all of it.

Example:

"2026-09-30T10:00:00.000Z"

Last modified on November 9, 2026