POST
cURL
Requires an organization-level external API token.
This endpoint creates a new location for the provided account. The account_id query parameter is required and identifies where the location should be created.
The address fields (address, postal, city, country_code) are conditionally required. If you provide any one of them, all four must be included. The country_code must be a valid ISO 3166-1 alpha-2 code, such as US, GB, or DE.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

account_id
string
required

Account ID where the location should be created.

Body

application/json
name
string
required

Name of the location

reference_id
string
required

Your external reference ID for this location. Must be unique within the account.

category_id
string
required

Primary Google category ID. Must start with 'categories/gcid:'

Pattern: ^categories/gcid:
address
string

Street address of the location. Required when any of postal, city, or country_code is provided.

postal
string

Postal / ZIP code. Required when any of address, city, or country_code is provided.

city
string

City name. Required when any of address, postal, or country_code is provided.

country_code
string

ISO 3166-1 alpha-2 country code (e.g. 'US', 'GB', 'DE'). Required when any of address, postal, or city is provided.

Pattern: ^[A-Z]{2}$
administrative_area
string

State, province, or administrative area

additional_address_lines
string[]

Additional address lines

description
string

Description of the location (max 750 characters)

phone_number
string

Primary phone number in E.164 format

Pattern: ^\+?[1-9]\d{6,14}$
additional_phone_numbers
string[]

Additional phone numbers in E.164 format (max 2)

Maximum array length: 2
Pattern: ^\+?[1-9]\d{6,14}$
website_uri
string<uri>

Website URL (must be a valid URL)

latitude
number

Geographic latitude

Required range: -90 <= x <= 90
longitude
number

Geographic longitude

Required range: -180 <= x <= 180
profile_logo_url
string<uri>

URL of the profile logo / image (must be a valid URL)

cover_url
string<uri>

URL of the cover image (must be a valid URL)

additional_category_ids
string[]

Additional Google category IDs

service_area_place_ids
string[]

Google Place IDs for the service area

service_area_place_names
string[]

Place names corresponding to the service area place IDs

placeId
string

Google Place ID of the location

regular_hours
object[]

Regular business hours

special_hours
object[]

Special business hours (holidays, events, etc.)

Response

Location created successfully

success
boolean
Example:

true

payload
object