Create Location

This endpoint creates a new location for the company, optionally with its weekly opening hours.

Important Notes

  • name, address, email, latitude and longitude are required.
  • address is an array of Google Maps address components, each with long_name and types.
  • times sets the opening hours, one entry per open day. Days not listed are closed.
  • country_id is optional: by default, the location takes the company's country.
  • New locations are created active. online_booking cannot be set on create; use the update endpoint.
  • The company is taken from the API key; company_id is never accepted.
  • Plan limits on the number of locations are not enforced by this endpoint.

Errors Dictionary

StatusErrorDetailDescription
400invalid_bodyexpected_objectRequest body is not a JSON object.
400invalid_address—Address must be a non-empty array with long_name and types keys.
400invalid_email—Email has an invalid format.
400invalid_coordinates—Latitude (-90 to 90) and longitude (-180 to 180) are required.
400invalid_timezone—Timezone must be a valid IANA identifier.
400missing_country_id—country_id was omitted and the company has no country to default to.
400invalid_country_id—The country is not one of the company's enabled countries.
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks locations:write scope.
422invalid_location_times—Opening hours have an invalid format, order, or duplicate days.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableconnection_failedThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Fields accepted when creating a location. The company comes from the API key.

string
required
length ≤ 255

Location name.

address
array of objects
required

Google Maps address components.

address*
string
required

Location email.

string

Location phone number.

integer

Country ID. Optional: by default, the company's country. When sent, it must be one of the company's enabled countries.

double
required
-90 to 90

Geographic latitude.

double
required
-180 to 180

Geographic longitude.

string

IANA timezone identifier.

times
array of objects

Opening hours, one entry per open day.

times
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json