PATCH
Update a blog category

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

blogCategoryId
string
required

Body

application/json

Every field is optional and every value is an absolute target, so replaying the same body converges without the idempotency ledger being reached. A body naming NO field is a 400: a patch that reported success for nothing would let a caller with a misspelled field read a green light for a no-op. ABSENT, PRESENT AND NULL ARE THREE DIFFERENT REQUESTS on description. Absent leaves the stored value alone, null CLEARS it, a value sets it. Null on slug or name is a 400 because both columns are NOT NULL, and null on sort_order is a 400 for a sharper reason: the service reads it as "leave alone", so accepting it would answer 200 having changed nothing. PATCH rather than PUT, because created_at is state this body cannot express and a whole-resource replacement reading would misdescribe what the request authorises.

slug
string

Normalised server-side. Renaming it CHANGES THE STOREFRONT URL for this category, and nothing redirects the old one.

name
string

Trimmed, and a blank name is a 400.

description
string | null

Send null to clear it. Omit to leave it alone.

sort_order
integer

Not nullable here. Omit it to leave the ordering alone.

Response

Success

data
object