Update a location

Update a location’s core fields (display name, subdomain, address, etc.).

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

locations:write

Path Parameters

Name	Type	Required	Description
`locationId`	string	Required	Location ID.

Request Body

Property	Type	Required	Description
`reference`	string	Optional	Display name.
`subdomain`	string	Optional	Free subdomain.
`code`	string	Optional	Internal reference code.
`addressLine1`	string	Optional	Address line 1.
`addressLine2`	string	Optional	Address line 2.
`addressCity`	string	Optional	City.
`addressState`	string	Optional	State / region.
`addressCountry`	string	Optional	Country.
`addressPostalCode`	string	Optional	Postal code.
`addressIsPublic`	boolean	Optional	Show address publicly.
`phoneNumberIsPublic`	boolean	Optional	Show the phone number publicly.

PATCHExample request

curl

curl -X PATCH "https://www.pxb.app/api/public/v1/locations/{locationId}" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "Acme Corp",
    "addressCity": "Austin"
  }'

200Example response

json

{
  "message": "Location updated successfully!",
  "content": {
    "location": {
      "id": "loc_abc123"
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Company menu → Locations → Location details

/dashboard

Open the company menu → Locations.
Open the ⋯ menu beside a location → Location details.