Add a location

Add a new location under an account. It's attached to the account's current plan automatically, and a connection slot is created for each review site on that plan. Returns the new location, including its id (data.data.id), which you need to connect its review sites. The account owner gets a location-added email. Duplicate locations (same name, address, postal code, and city) are rejected.

Prerequisites: the account's id (account_id) and a city_id.

Authentication: Partner token. account_id must be an existing, not deleted account inside your own account tree; otherwise 422.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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. Max 100 characters, no < or >. Defaults to the city name.

string
Defaults to loc-001

Your own id for the location. Max 100 characters, no < or >. Defaults to "".

string
required
Defaults to 12 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 0291234567

The primary business phone. 9 to 15 characters.

string

A secondary phone line. 9 to 15 characters.

integer
required
Defaults to 5994

The account to add the location to.

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