Add a location
create_locationAdd a location to the locator. A plain address is geocoded automatically, so lat and lng are only needed to override the result. Counts against the plan's location allowance.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lat | No | Latitude. Supplying lat and lng skips geocoding. | |
| lng | No | Longitude. | |
| city | No | ||
| name | Yes | Business or store name. | |
| No | |||
| hours | No | Opening hours keyed by ISO weekday, 1 = Monday. Each value is a list of {open, close} in 24h HH:MM, or null for closed. | |
| phone | No | ||
| state | No | ||
| address | No | Full address as a person would write it. Geocoded automatically unless lat and lng are supplied. | |
| website | No | ||
| imageUrl | No | ||
| priority | No | Higher sorts first when there is no visitor position. | |
| timezone | No | IANA timezone, for example America/Chicago. | |
| postalCode | No | ||
| visibility | No | hidden keeps the location in the account but off the public locator. | |
| countryCode | No | Two-letter ISO country code. | |
| description | No | ||
| markerColor | No | Hex colour for this location's map marker. | |
| addressLine1 | No | Street line, when the address is structured. | |
| customFields | No | Extra fields, keyed by the label shown to visitors. The value is either a plain string, or an object {value, color, icon, style} where `value` is the URL or text. There is no `label` or `url` key: the label is the key, and the URL goes in `value`. Example: {"Book a table": {"value": "https://example.com/book", "color": "#C2540E"}}. Never use this for tags or categories; use the categories field instead. | |
| locationType | No | point is a physical address, service_area covers a radius, online is a stockist with no address. | |
| serviceRadiusKm | No | Radius in km, for a service_area location. |