Create a location

ID of the client to create this location under. Look it up with GET /api/v1/clients. Optional, like "Without a client" in the app: leave it out and the location is created on its own. A key limited to specific clients must send one.

location (the default) is a physical business listing. website is a website entity — a brand's site tracked for reviews, SEO, AEO and social — created from a name and a website alone. It is not a billable location, and it needs website entities enabled for the workspace (403 otherwise).

The location's business name.

ISO country code, e.g. US.

Street address.

Street address, line 2.

City.

State or region code.

Postal or ZIP code.

Phone number.

Any additional phone numbers beyond the primary one.

Website URL.

General category id, from GET /api/v1/locations/categories. A location needs a category: send this, categoryName, or publisherCategories.google.

General category display name. A location needs a category: send this, categoryId, or publisherCategories.google. A name that doesn't match the catalog is kept as the display category.

Per-publisher categories, one per publisher, each an { id, name } looked up via GET /api/v1/locations/publisher-categories. On create, publisherCategories.google also satisfies the category requirement.

Up to 9 extra categories, each an { id?, name }. A bare name is accepted and its id is resolved from the category catalog where one matches. Look up ids yourself with GET /api/v1/locations/categories.

A short description of the business.

Internal tags for your own organization — not shown publicly.

Latitude, in decimal degrees. Derived automatically from the address if omitted.

Longitude, in decimal degrees. Derived automatically from the address if omitted.

Custom field values to set on this location, keyed by field id.

Service-area settings on Master, for a business that serves customers at their location. Set businessType to CUSTOMER_LOCATION_ONLY to hide the street address: no publisher is sent a street it would show, even if one is stored. Send null to clear it. To set it for some publishers only, use publisherServiceAreas or applyToPublishers.

CUSTOMER_LOCATION_ONLY hides the address (service area only). CUSTOMER_AND_BUSINESS_LOCATION shows the address and the areas served.

Areas served, up to 20. Each is { name, placeId?, placeType? }. Google and Bing publish them. Facebook and Apple have no list of service areas, so for them only the hidden street applies.

Google Place ID of the area. Google only accepts places that have one, so a place without it is saved but not sent to Google.

A different service area for Google, Facebook, Apple or Bing, each in the same shape as serviceArea. It is stored as that publisher's own value and returned in publisherOverrides. A publisher you leave out uses serviceArea.

Service-area settings on Master, for a business that serves customers at their location. Set businessType to CUSTOMER_LOCATION_ONLY to hide the street address: no publisher is sent a street it would show, even if one is stored. Send null to clear it. To set it for some publishers only, use publisherServiceAreas or applyToPublishers.

CUSTOMER_LOCATION_ONLY hides the address (service area only). CUSTOMER_AND_BUSINESS_LOCATION shows the address and the areas served.

Areas served, up to 20. Each is { name, placeId?, placeType? }. Google and Bing publish them. Facebook and Apple have no list of service areas, so for them only the hidden street applies.

Google Place ID of the area. Google only accepts places that have one, so a place without it is saved but not sent to Google.

Service-area settings on Master, for a business that serves customers at their location. Set businessType to CUSTOMER_LOCATION_ONLY to hide the street address: no publisher is sent a street it would show, even if one is stored. Send null to clear it. To set it for some publishers only, use publisherServiceAreas or applyToPublishers.

CUSTOMER_LOCATION_ONLY hides the address (service area only). CUSTOMER_AND_BUSINESS_LOCATION shows the address and the areas served.

Areas served, up to 20. Each is { name, placeId?, placeType? }. Google and Bing publish them. Facebook and Apple have no list of service areas, so for them only the hidden street applies.

Google Place ID of the area. Google only accepts places that have one, so a place without it is saved but not sent to Google.

Service-area settings on Master, for a business that serves customers at their location. Set businessType to CUSTOMER_LOCATION_ONLY to hide the street address: no publisher is sent a street it would show, even if one is stored. Send null to clear it. To set it for some publishers only, use publisherServiceAreas or applyToPublishers.

CUSTOMER_LOCATION_ONLY hides the address (service area only). CUSTOMER_AND_BUSINESS_LOCATION shows the address and the areas served.

Areas served, up to 20. Each is { name, placeId?, placeType? }. Google and Bing publish them. Facebook and Apple have no list of service areas, so for them only the hidden street applies.

Google Place ID of the area. Google only accepts places that have one, so a place without it is saved but not sent to Google.

Service-area settings on Master, for a business that serves customers at their location. Set businessType to CUSTOMER_LOCATION_ONLY to hide the street address: no publisher is sent a street it would show, even if one is stored. Send null to clear it. To set it for some publishers only, use publisherServiceAreas or applyToPublishers.

CUSTOMER_LOCATION_ONLY hides the address (service area only). CUSTOMER_AND_BUSINESS_LOCATION shows the address and the areas served.

Areas served, up to 20. Each is { name, placeId?, placeType? }. Google and Bing publish them. Facebook and Apple have no list of service areas, so for them only the hidden street applies.

Google Place ID of the area. Google only accepts places that have one, so a place without it is saved but not sent to Google.

Social profile URLs: facebook, instagram, twitter, linkedin, youtube, tiktok, pinterest. On update only the keys you send change; null clears one. Published to Google as its url_* attributes and to Bing and Apple.