PATCH
Rename a customer group or update its metadata

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key
string
required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

customerGroupId
string
required

Body

application/json

At least one field is required; an empty object is refused rather than treated as a no-op. name and metadata are each optional independently.

name
string
metadata
object | null

THREE STATES, all distinct: omit the key to leave the stored bag untouched, send null or {} to clear it, send an object to replace it wholesale. There is no per-key merge.

Response

Success

data
object