clientIdstringopcional
The id of the client this location belongs to (find it with list_clients). Omit to add the location without a client. Accepts the database ID or public cli- ID. IDs must belong to the authenticated agency and permitted client.
kind"location" | "website"opcional
"location" (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 `website` URL alone: no address, category or country is needed, it isn't a billable location, and it is only available to workspaces with website entities enabled.
namestringobrigatório
The location's business name (required).
countryIsostringopcional
The location's country as a two-letter ISO-3166-1 alpha-2 code, e.g. "US" or "GB" (required). Determines which directories the location can be listed in.
streetstringopcional
Street address, line 1.
street1stringopcional
Street address, line 2.
stateIsostringopcional
State or region, as an ISO code (e.g. "CA").
postalCodestringopcional
Postal or ZIP code.
serviceAreaobjectopcional
Service-area settings — for a business that serves customers at their location. businessType CUSTOMER_LOCATION_ONLY hides the street address on Google (a pure service-area business; the street is never sent there); CUSTOMER_AND_BUSINESS_LOCATION shows the address plus the areas served. places is up to 20 areas, each { name, placeId? }; Google only accepts places with their Google Place ID, so pass placeId for every place you want on Google.
businessType"CUSTOMER_LOCATION_ONLY" | "CUSTOMER_AND_BUSINESS_LOCATION"opcional
Service-area type.
placesobject[]opcional
Areas served (max 20).
namestringopcional
Place name, e.g. "Austin, TX, USA".
placeIdstringopcional
Google Place ID of the area.
publisherServiceAreasobjectopcional
A different service area per publisher, stored as that publisher's own value; a publisher left out uses serviceArea. Each key is a serviceArea object (same shape).
googleobjectopcional
Service-area settings — for a business that serves customers at their location. businessType CUSTOMER_LOCATION_ONLY hides the street address on Google (a pure service-area business; the street is never sent there); CUSTOMER_AND_BUSINESS_LOCATION shows the address plus the areas served. places is up to 20 areas, each { name, placeId? }; Google only accepts places with their Google Place ID, so pass placeId for every place you want on Google.
businessType"CUSTOMER_LOCATION_ONLY" | "CUSTOMER_AND_BUSINESS_LOCATION"opcional
Service-area type.
placesobject[]opcional
Areas served (max 20).
namestringopcional
Place name, e.g. "Austin, TX, USA".
placeIdstringopcional
Google Place ID of the area.
facebookobjectopcional
Service-area settings — for a business that serves customers at their location. businessType CUSTOMER_LOCATION_ONLY hides the street address on Google (a pure service-area business; the street is never sent there); CUSTOMER_AND_BUSINESS_LOCATION shows the address plus the areas served. places is up to 20 areas, each { name, placeId? }; Google only accepts places with their Google Place ID, so pass placeId for every place you want on Google.
businessType"CUSTOMER_LOCATION_ONLY" | "CUSTOMER_AND_BUSINESS_LOCATION"opcional
Service-area type.
placesobject[]opcional
Areas served (max 20).
namestringopcional
Place name, e.g. "Austin, TX, USA".
placeIdstringopcional
Google Place ID of the area.
appleobjectopcional
Service-area settings — for a business that serves customers at their location. businessType CUSTOMER_LOCATION_ONLY hides the street address on Google (a pure service-area business; the street is never sent there); CUSTOMER_AND_BUSINESS_LOCATION shows the address plus the areas served. places is up to 20 areas, each { name, placeId? }; Google only accepts places with their Google Place ID, so pass placeId for every place you want on Google.
businessType"CUSTOMER_LOCATION_ONLY" | "CUSTOMER_AND_BUSINESS_LOCATION"opcional
Service-area type.
placesobject[]opcional
Areas served (max 20).
namestringopcional
Place name, e.g. "Austin, TX, USA".
placeIdstringopcional
Google Place ID of the area.
bingobjectopcional
Service-area settings — for a business that serves customers at their location. businessType CUSTOMER_LOCATION_ONLY hides the street address on Google (a pure service-area business; the street is never sent there); CUSTOMER_AND_BUSINESS_LOCATION shows the address plus the areas served. places is up to 20 areas, each { name, placeId? }; Google only accepts places with their Google Place ID, so pass placeId for every place you want on Google.
businessType"CUSTOMER_LOCATION_ONLY" | "CUSTOMER_AND_BUSINESS_LOCATION"opcional
Service-area type.
placesobject[]opcional
Areas served (max 20).
namestringopcional
Place name, e.g. "Austin, TX, USA".
placeIdstringopcional
Google Place ID of the area.
socialLinksobjectopcional
Social profile URLs. Only the keys you pass change; pass null for a key to clear it. Published to Google as url_* attributes and to Bing/Apple's social fields — don't send those as attributes.
facebookopcional
Facebook page URL.
instagramopcional
Instagram URL.
twitteropcional
X/Twitter URL.
linkedinopcional
LinkedIn URL.
youtubeopcional
YouTube URL.
tiktokopcional
TikTok URL.
pinterestopcional
Pinterest URL.
paymentMethodsstring[]opcional
Payment methods accepted, e.g. "Visa", "American Express", "Cash only" (replaces the existing list; [] clears it). Published to Google as pay_* attributes, and to Apple and Bing.
phonestringopcional
Primary phone number.
additionalPhonesstring[]opcional
Any additional phone numbers.
websitestringopcional
The location's website URL.
categoryIdstringopcional
General category id — look it up with list_categories.
categoryNamestringopcional
General category display name (from list_categories). At least this or publisherCategories.google is required — creation fails without some category.
publisherCategoriesobjectopcional
Per-publisher categories, one per publisher. Each is an { id, name } looked up with list_publisher_categories. At least publisherCategories.google or categoryName is required — creation fails without some category.
idstringopcional
The publisher's own category id (from list_publisher_categories)
namestringopcional
The category's display name
idstringopcional
The publisher's own category id (from list_publisher_categories)
namestringopcional
The category's display name
idstringopcional
The publisher's own category id (from list_publisher_categories)
namestringopcional
The category's display name
idstringopcional
The publisher's own category id (from list_publisher_categories)
namestringopcional
The category's display name
additionalCategoriesobject[]opcional
Up to 9 extra categories, each an { id?, name }.
namestringopcional
Category name
descriptionstringopcional
A description of the business.
tagsstring[]opcional
Internal tags for your own organization — not shown publicly.
customFieldsobjectopcional
Values for the agency's custom location fields, as { fieldKey: value } (keys from list_custom_field_definitions; values are validated against each field's type). Same shape set_custom_field_value takes one at a time.
latitudenumberopcional
Latitude. Derived automatically from the address if omitted.
longitudenumberopcional
Longitude. Derived automatically from the address if omitted.