Skip to main content
PATCH
Update Location

Authorizations

Authorization
string
header
required

Company API key from the developer platform. Header: Authorization: Bearer cw_live_…. Key must include customers:read and/or customers:write.

Path Parameters

id
string<uuid>
required

Query Parameters

expand
string

Body

application/json
name
null | string
Required string length: 1 - 255
locationNote
null | string
Maximum string length: 2000
purchaseOrderNumber
null | string
Maximum string length: 255
address
string

Street address to re-geocode. When set, replaces the stored address JSON.

Required string length: 1 - 500
status
enum<string>

Set to "ACTIVE" to reactivate an inactive location.

Available options:
ACTIVE,
INACTIVE

Response

200 - application/json
data
object
required