Edit a location

Change a location's name, label, your client_location_id, address, website, or phone numbers. This replaces the record, so send every field, not just what changed: an optional field you leave out is cleared. A location with the same name, address, postal code and city as another location is rejected.

Prerequisites: the location's id (storeId). Get one location gives you the current values to start from.

Authentication: Partner token. The location must be inside your account tree (otherwise 404); a location that belongs to another partner returns 403.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Defaults to 3076

Required. The location's id.

Body Params
string
required
Defaults to Acme Plumbing - North

The location's name. Max 255 characters, no < or >.

string
Defaults to NORTH-01

A display label for the location (for example NYC01), not the numeric id. Max 100 characters, no < or >.

string
Defaults to loc-001

Your own id for the location. Max 100 characters, no < or >. Saved as "" when left out.

string
required
Defaults to 14 King Street

Street address. Max 255 characters, no < or >.

integer
required
Defaults to 3243

The city. Must be an existing city id.

string
required
Defaults to 2000

Postal code. 3 to 12 characters, no < or >.

string
Defaults to https://acmebrand.com

The location's website. Must be a valid URL.

string
Defaults to 9876543210

A secondary phone line. 9 to 15 characters.

string
Defaults to 0291234567

The primary business phone. 9 to 15 characters.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json