Locations
Create a location
Add a location, with or without a street address or opening hours.
POST
Requires
Do not send an hours array or weekday objects containing
location:create and project API access. Returns 200 and the location resource.
string
required
The public project ID.
string
required
Location name.
string
required
City. A street address is optional.
string
Street address.
string
Additional address information.
string
State or region.
string
Postal code.
string
Country.
number
Latitude between -90 and 90.
number
Longitude between -180 and 180.
boolean
Whether the location is shown. Supply this explicitly when you need a particular visibility.
object
A full weekday schedule, or
{} for no schedule.string
Phone number.
string
Email address.
string
Website URL.
Opening hours
Omithours or send {} for a location without hours. You do not need to invent opening times for coming-soon locations.
A nonempty POST hours object requires all seven weekdays. Use short keys mon, tue, wed, thu, fri, sat, sun, or the corresponding full weekday names.
Values are time-range strings, closed, or null for an unset day:
open/close keys.
Additional fields
The response’s
socials list is derived; send individual public social field names when writing.
POST can geocode synchronously when either coordinate is missing or zero. Supplying both nonzero coordinates avoids depending on a geocoding result. Zero passes validation, but POST and PUT retain this older geocoding behavior; PATCH preserves supplied zero coordinates.
Errors: 401, 403, 404, 422, 429. Invalid input does not create a partially populated location. See errors.