Skip to main content
PATCH
Rename a locked revision

Authorizations

Authorization
string
header
required

A Phrase Platform JWT issued for Orchestrator, sent as Authorization: Bearer <JWT>. See Authentication and access for how to obtain one.

Path Parameters

workflow_id
integer
required

ID of the workflow the revision belongs to.

Example:

123

id
integer
required

ID of the revision.

Example:

789

Body

application/json

Revision attributes to change

Attributes to change on a locked revision.

name
string
required

New name of the revision. Must be unique within the workflow. An empty string resets it to Revision <sequence>.

Example:

"Before translation step changes"

Response

OK

A versioned snapshot of a workflow's trigger and actions.

id
integer
required

Unique identifier of the revision.

Example:

314

name
string
required

Name of the revision.

Example:

"Revision 2"

sequence
integer
required

Position of the revision within its workflow, starting at 1.

Example:

2

workflow_id
integer
required

Identifier of the workflow the revision belongs to.

Example:

42

inserted_at
string<date-time>

When the revision was created.

Example:

"2026-01-14T11:02:11.000000Z"

locked_at
string<date-time> | null

When the revision became read-only, or null for the editable latest revision. A revision is locked when it's published, or when it's saved under a name (Rename in the UI, or POST /workflows/{workflow_id}/revisions) and a new draft replaces it.

Example:

"2026-01-15T09:30:00.000000Z"

paused_at
string<date-time> | null

When the revision was paused, or null if it is not paused. A paused revision stays published but its workflow stops reacting to triggers. Revisions can be paused automatically when your account exceeds plan limits, such as too many actions executed or too many workflows published.

Example:

"2026-02-01T00:00:00.000000Z"

published_at
string<date-time> | null

When the revision was published, or null when it is not published.

Example:

"2026-01-15T09:30:00.000000Z"

updated_at
string<date-time>

When the revision was last changed.

Example:

"2026-01-15T09:30:00.000000Z"

url
string<uri>

Direct link to the entity in the Orchestrator UI.

Example:

"https://eu.phrase.com/orchestrator/manage/workflows/42/editor/314"