Skip to main content
POST
Promote a procedure version
Promotes a provisional procedure version (active, not yet approved) to approved, as Console’s promote does, and completes its synthesis request when it has one. The change goes through the procedure lifecycle. Any other state is 409 invalid_state; a version whose declaration does not pass its governance contract is 409 conflict (for example, no required permission keys); its author must repair it first.

Who may promote

You need procedures:approve at the version’s home; a missing version and one out of reach are the same 404 resource_missing. It is an approve permission: a Personal key carries it only when its owner opts in, an External App only by an explicit grant, and a Forge agent never. The promotion is audited with you as the actor.

Idempotency

With an Idempotency-Key, a same-key repeat within 24 hours returns the recorded result only while you still hold procedures:approve at the version’s home; otherwise 409 idempotency_result_unavailable.

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

procedureId
string
required

The procedure family's id (its slug).

Minimum string length: 1

Body

application/json
version
string
required

The semver version.

Minimum string length: 1

Response

Success

data
object
required
meta
object
required