Skip to navigation
API referenceCatalogue

Approve a catalogue Variant revision

Approves a draft revision. The body names the approved_snapshot_digest you reviewed; a revision whose snapshot is not that digest answers 409 REVISION_DIGEST_MISMATCH, so an approval always binds the content that was read. A revision is decided once: approving or rejecting it again answers 409 REVISION_DECIDED. Approving does not publish. Send an Idempotency-Key: a retry with the same key and the same request answers the first response, byte for byte, with Idempotency-Replayed: true, so a response you did not receive is safe to retry. Requires the catalogue.approve scope, which your account operator provisions; no other catalogue scope implies it. Served only where the catalogue is enabled for your environment.

Authentication

X-API-Keystring

API key for one environment of your account. Keep server-side; never expose in browser clients.

Path parameters

variant_idstringRequired
revisionstringRequired

Headers

Idempotency-Keystring or nullOptional

Request

Approve a draft revision, binding the snapshot digest the reviewer read.
approved_snapshot_digeststringRequired

Response

The revision, approved
appearancemap from strings to any
applicationslist of objects
approved_snapshot_digeststringformat: "^sha256:[0-9a-f]{64}$"
authored_intent_digeststringformat: "^sha256:[0-9a-f]{64}$"
created_atdatetime
decided_atdatetime or null
decision_stateenum
Allowed values:
default_application_idstring
digest_versionenum
Allowed values:
display_colorstringformat: "^#[0-9A-F]{6}$"
revisioninteger>=1
variant_idstring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
503
Service Unavailable Error