Skip to main content
PATCH
Update a step library entry
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

PATCH /api/v2/workflows/updateStep changes the named fields of one step and returns it.

Authentication

External App credential or platform API key, or a Personal key. Requires permission workflows:manage (an elevated permission) held at the platform scope; a key or app granted only at some org units receives 403. Forge agents can never hold workflows:manage. Because the success returns what was written, the credential’s scopes must include workflows:read as well; otherwise 403 naming workflows:read, and nothing is written. A Personal key acts as its owner; an External App or platform key acts as itself. The change is audited with that actor and, for an app or platform key, who granted it. The body names the step by id (from listSteps) and at least one field to change. An unknown step returns 404. Send an Idempotency-Key to make a retry safe: a same-key retry within 24 hours returns the recorded result only while the caller still holds workflows:read and workflows:manage at the platform scope; otherwise 409 idempotency_result_unavailable, and the write never runs twice (see Idempotency). Without a key, a repeat writes the same values again.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

stepId
string
required

The step's id from listSteps.

Minimum string length: 1

Body

application/json
displayName
string
Minimum string length: 1
description
string
category
string
Minimum string length: 1
tags
string[]
Minimum string length: 1
command
string

The command the step runs.

Minimum string length: 1
role
string
Minimum string length: 1
timeout
integer

Seconds.

onFailure
string
Minimum string length: 1
inputs
object
outputs
object
successCriteria
string[]
Minimum string length: 1
isPublic
boolean

Default true.

Response

Success

data
object
required
meta
object
required