clientIdstringoptional
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"optional
"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.
namestringerforderlich
The location's business name (required).
countryIsostringoptional
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.
streetstringoptional
Street address, line 1.
street1stringoptional
Street address, line 2.
stateIsostringoptional
State or region, as an ISO code (e.g. "CA").
postalCodestringoptional
Postal or ZIP code.
serviceAreaobjectoptional
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"optional
Service-area type.
placesobject[]optional
Areas served (max 20).
namestringoptional
Place name, e.g. "Austin, TX, USA".
placeIdstringoptional
Google Place ID of the area.
publisherServiceAreasobjectoptional
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).
googleobjectoptional
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"optional
Service-area type.
placesobject[]optional
Areas served (max 20).
namestringoptional
Place name, e.g. "Austin, TX, USA".
placeIdstringoptional
Google Place ID of the area.
facebookobjectoptional
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"optional
Service-area type.
placesobject[]optional
Areas served (max 20).
namestringoptional
Place name, e.g. "Austin, TX, USA".
placeIdstringoptional
Google Place ID of the area.
appleobjectoptional
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"optional
Service-area type.
placesobject[]optional
Areas served (max 20).
namestringoptional
Place name, e.g. "Austin, TX, USA".
placeIdstringoptional
Google Place ID of the area.
bingobjectoptional
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"optional
Service-area type.
placesobject[]optional
Areas served (max 20).
namestringoptional
Place name, e.g. "Austin, TX, USA".
placeIdstringoptional
Google Place ID of the area.
socialLinksobjectoptional
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.
facebookoptional
Facebook page URL.
instagramoptional
Instagram URL.
twitteroptional
X/Twitter URL.
linkedinoptional
LinkedIn URL.
youtubeoptional
YouTube URL.
tiktokoptional
TikTok URL.
pinterestoptional
Pinterest URL.
paymentMethodsstring[]optional
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.
phonestringoptional
Primary phone number.
additionalPhonesstring[]optional
Any additional phone numbers.
websitestringoptional
The location's website URL.
categoryIdstringoptional
General category id — look it up with list_categories.
categoryNamestringoptional
General category display name (from list_categories). At least this or publisherCategories.google is required — creation fails without some category.
publisherCategoriesobjectoptional
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.
idstringoptional
The publisher's own category id (from list_publisher_categories)
namestringoptional
The category's display name
idstringoptional
The publisher's own category id (from list_publisher_categories)
namestringoptional
The category's display name
idstringoptional
The publisher's own category id (from list_publisher_categories)
namestringoptional
The category's display name
idstringoptional
The publisher's own category id (from list_publisher_categories)
namestringoptional
The category's display name
additionalCategoriesobject[]optional
Up to 9 extra categories, each an { id?, name }.
namestringoptional
Category name
descriptionstringoptional
A description of the business.
tagsstring[]optional
Internal tags for your own organization — not shown publicly.
customFieldsobjectoptional
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.
latitudenumberoptional
Latitude. Derived automatically from the address if omitted.
longitudenumberoptional
Longitude. Derived automatically from the address if omitted.