Skip to main content
PUT
Set the display name and presentation copy for your offering

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

ref
string
required

the offering code to merchandise (offering_ref = the catalog offering/SKU code).

Minimum string length: 1

Body

application/json

The CLIENT merchandise request body — DISPLAY CONTENT ONLY. Billing and shipping cadence (billing_frequency / shipping_frequency) are money-movement configuration set by the PLATFORM, never on this surface: they are not accepted here and a client-supplied cadence field is rejected (422). The brand (from your key) and the offering (from the path {ref}) are applied for you; a brand_id or offering_ref carried here is structurally inert (overwritten — the anti-spoof). The brand and offering must already exist — this request never creates them.

description
string
required

non-empty offering description.

Minimum string length: 1
display_name
string
required

non-empty display name shown in checkout + the member portal (never the raw SKU code).

Minimum string length: 1
includes
string[]
required

the what-is-included bullet lines — non-empty strings (the array itself may be empty).

brand_id
string

structurally inert — if carried it is OVERWRITTEN with the brand your key owns (the anti-spoof); you never name a brand on this surface.

offering_ref
string

structurally inert — if carried it is OVERWRITTEN with the path {ref} (the anti-spoof).

Response

merchandising updated — or an idempotent replay of the original write

data
object
required

The display content for one of your offerings, keyed by (brand, offering_ref). Product copy, scoped to your brand — not a price, and it carries no personal health information.