Skip to main content
POST
Enable an offering for your brand

Authorizations

Authorization
string
header
required

Per-client API key (M2M). Presented as Authorization: Bearer <key>.

Headers

X-Brand-Id
string
required

Opaque brand id (brd_...). Validated to belong to the resolved client (§2).

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$
Idempotency-Key
string

Accepted on mutations; carried in trusted context, enforced in a later WI.

Path Parameters

brand_id
string
required

the brand to enable the offering for (must match X-Brand-Id).

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$

Body

application/json

The enable request body — the offering to enable for your brand. The brand is resolved from your key (the path brand_id must match X-Brand-Id) and is never carried here.

offering_ref
string
required

the offering code to enable (offering_ref = the catalog offering/SKU code); must exist in the canonical catalog.

Minimum string length: 1

Response

the offering was already enabled — an idempotent re-enable or replay

data
object
required

An enablement record with its computed activation status. The status is derived from the activation checks on every response — never stored and never writable; "active" cannot appear while any performed check fails, a check is unverifiable, or a check was not performed.