PATCH
Correct a retail location

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

locationId
string
required

Body

application/json

A PATCH, not the dashboard's full replace: an omitted key keeps its stored value. The six nullable fields (address_line_2, region, postal_code, phone, email, website_url) may be set to null to CLEAR them, which is a different claim from an empty string and is rendered differently by every consumer of this feed. A null on any other field is a 400 rather than a silent no-op. hours, custom_fields and tags REPLACE wholesale rather than merging, so a seasonal closure can delete one day rather than only add to it. The address is re-resolved on every patch, so a client changing several fields should send them in one call.

slug
string
name
string
address_line_1
string
address_line_2
string | null
city
string
region
string | null
postal_code
string | null
country_code
string
phone
string | null
email
string | null
website_url
string | null
hours
object
custom_fields
object
tags
string[]
is_active
boolean
position
integer

Response

Success

data
object