Update a location, or many at once
update_locationChange one or more fields on an existing location. Only the fields you send are touched. Changing the address re-geocodes it. Pass ids instead of id to apply the same fields to many locations in one call, for example hiding a batch or setting priority across a region; address, coordinates and name stay one-at-a-time.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Location id. | |
| ids | No | Several location ids, to apply the same change to all of them in one call (at most 200). Use either id or ids. | |
| lat | No | Latitude. Supplying lat and lng skips geocoding. | |
| lng | No | Longitude. | |
| city | No | ||
| name | No | Business or store name. | |
| No | |||
| hours | No | Opening hours keyed by ISO weekday, 1 = Monday. Each value is ONE {open, close} in 24h HH:MM, or null for closed — not a list, and a list is rejected. Example: {"1": {"open": "09:00", "close": "17:00"}, "7": null}. REPLACES the whole week: any day left out is cleared. To change one day without restating the rest, use hoursPatch. | |
| 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. | |
| hoursPatch | No | Change only the days named, leaving every other day exactly as it is. Same shape as hours but partial: {"7": {"open": "10:00", "close": "16:00"}} changes Sunday alone, and {"7": null} closes it. Use this to edit hours; it cannot silently revert a day you did not mention. Ignored if hours is also sent. | |
| 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. | |
| onlineRegions | No | For an online location: two-letter country codes it ships to or serves, e.g. ["us", "ca"]. Empty means every visitor sees it. | |
| serviceRadiusKm | No | Radius in km, for a service_area location. | |
| serviceAreaCircleVisible | No | For a service_area location: whether to draw its coverage circle. Null (the default) follows the locator's serviceAreaCircleVisible setting. False draws the pin without the circle. |