Skip to main content
POST
Rename a procedure
Changes a procedure family’s display name, with a reason of at least 8 characters, as Console’s rename action does. Versions never change once minted, so the rename mints a new approved minor version carrying the name, and vendor links pick up the new label. Renaming to the name the head already has changes nothing: minted is false and version is the head. The family’s procedureId (its slug) never changes.

Who may rename

You need procedures:manage at the home of the family’s head version (its highest active version, else its highest version). A missing family and one out of reach are the same 404 resource_missing. The rename is audited (procedure_display_name_renamed) 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:manage at the family head’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
name
string
required

The new display name, trimmed.

reason
string
required

Why, for the audit trail: at least 8 characters.

Response

Success

data
object
required

The family's head version after the rename. minted is false when the name was already the head's and nothing changed.

meta
object
required