PATCH
Rename or retype a shipping profile

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

shippingProfileId
string
required

Body

application/json

An omitted key keeps its stored value. An EMPTY body is refused rather than treated as a no-op, because the merge still writes the row and would move updated_at, which is the field you sync incrementally on.

name
string
Maximum string length: 200
type
enum<string>
Available options:
default,
gift_card,
custom

Response

Success

data
object