Updates a place

Updates a place, send empty array to remove values for an array type parameter, null values will be ignored. eg. {"parkings": []} to clear parkings of a places instead of {"parkings": null}. The 'name' parameter can be updated to change the human-readable name of the place.

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

place_handle*string

Query Parameters

update_associated_orders?|

If true, updates all non-terminal orders associated with this place_handle to reflect the updated place destination.

update_geometry_using_address?|

If true, geocodes the place using the address provided in the request body and updates the geometry with the geocoded coordinates.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

place_handle?|

Human friendly handle of place

name?|

Human readable name of the place

geometry?|

Location or geofence for this place

radius?|

Radius of geofence in case geometry is a Point

address?|

Address associated with the place

timings?array<>|

Expected (open) timings for this place

metadata?|

Metadata - any additional data in form of json

closed_on?array<string>|

Dates when this place will be closed

expected_service_time?|

Expected service/work time at this place

detect_visits?|

Deprecated

DEPRECATED: This field is no longer supported and will be removed in a future version. Setting detect_visits to true will result in an error. Visit detection functionality has been discontinued. Use Orders API to detect visits to shift destinations instead.

geofence_id?|

Deprecated

UUID of the associated geofence.

address_components?

Structured address components for more accurate geocoding. Fields: country, state, city, postal_code, street.

place_type?|

Type of place, used to restrict the maximum bounding box size during geocoding.

Type	Max Area	Approx. Size	Description
shop	5,000 m²	~71m x 71m	Small retail shop or store
house	2,000 m²	~45m x 45m	Residential house or apartment
restaurant	5,000 m²	~71m x 71m	Restaurant, cafe, or eatery
office	10,000 m²	~100m x 100m	Office building or coworking space
warehouse	50,000 m²	~224m x 224m	Warehouse or distribution center
hospital	100,000 m²	~316m x 316m	Hospital or large medical facility
mall	200,000 m²	~447m x 447m	Shopping mall or large retail complex
university	5,000,000 m²	~2.2km x 2.2km	University or large campus
golf_course	8,000,000 m²	~2.8km x 2.8km	Golf course or large sports complex
stadium	1,000,000 m²	~1.0km x 1.0km	Stadium or arena with parking
airport	8,000,000 m²	~2.8km x 2.8km	Airport or airfield

If not specified, the default max area is 2,000,000 m² (~1.4km x 1.4km).

parkings?array<>|

Parkings around place

checkins?array<>|

Checkin or Clockin locations at place

visit_detection_config?

Configuration as json to detect the visit based on the key value pair provided with it. This could be worker_handle or some logical grouping attached with worker's metadata.

suggestion_used?|

If the geofence is applied using inferred geofence or bounding box

suggestion_id?|

Id of the suggestion used to update the geofence

locked_from_suggestions?|

Whether this place is locked from receiving future suggestions. defaults to true if suggestion_used is false

suggestions_reviewed_on?|

Timestamp (ISO 8601) when suggestions were last reviewed for this place

Response Body

`application/json`

curl -X PATCH "https://example.com/places/v1/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "place_handle": "string",  "name": "string",  "geometry": {    "coordinates": [      0    ],    "type": "Point"  },  "radius": 0,  "address": "string",  "timings": [    {      "day_of_week": "MONDAY",      "start_time": "string",      "end_time": "string"    }  ],  "metadata": {    "property1": null,    "property2": null  },  "closed_on": [    "string"  ],  "expected_service_time": 0,  "detect_visits": true,  "geofence_id": "string",  "address_components": {    "country": "string",    "state": "string",    "city": "string",    "postal_code": "string",    "street": "string"  },  "place_type": "shop",  "place_id": "f0968ed8-288a-49fe-ae98-74c720303b1b",  "last_updated": "string",  "order_count": 0,  "inferred_geofences": [    {      "geometry": {        "type": "Polygon",        "coordinates": [          [            [              0            ]          ]        ]      },      "source": "customer_provided",      "inclusivity": "string",      "skew": 0,      "area_ratio": 0,      "centroid_shift": 0    }  ],  "inferred_geofences_skew": 0,  "visit_detection_config": {    "worker_handle": "string",    "metadata_filter": {      "property1": null,      "property2": null    }  },  "inferred_geofence": {    "geometry": {      "type": "Polygon",      "coordinates": [        [          [            0          ]        ]      ]    },    "source": "customer_provided",    "inclusivity": "string",    "skew": 0,    "area_ratio": 0,    "centroid_shift": 0  },  "bounding_box": {    "geometry": {      "type": "Polygon",      "coordinates": [        [          [            0          ]        ]      ]    },    "source": "customer_provided",    "skew": 0,    "area_ratio": 0,    "centroid_shift": 0  },  "created_by": {    "source": "string",    "timestamp": "string",    "ip-address": "string",    "device_id": "string",    "driver_handle": "string",    "user_id": "string",    "email": "string"  },  "updated_by": {    "source": "string",    "timestamp": "string",    "ip-address": "string",    "device_id": "string",    "driver_handle": "string",    "user_id": "string",    "email": "string"  },  "locked_from_suggestions": true,  "suggestion_applied": true,  "suggestion_applied_on": "string",  "has_pending_suggestion": true,  "suggestion_not_applied_reason": "string",  "suggestions_reviewed_on": "string",  "parkings": [    {      "geometry": {        "type": "Point",        "coordinates": [          0        ]      },      "score": 0,      "source": "customer_provided"    }  ],  "checkins": [    {      "geometry": {        "type": "Point",        "coordinates": [          0        ]      },      "score": 0,      "source": "customer_provided"    }  ],  "service_areas": [    {      "geometry": {        "type": "Polygon",        "coordinates": [          [            [              0            ]          ]        ]      },      "source": "customer_provided"    }  ],  "completions": [    {      "geometry": {        "type": "Point",        "coordinates": [          0        ]      },      "score": 0,      "source": "customer_provided"    }  ],  "suggestions": [    {      "suggestion_id": "string",      "geometry": {        "coordinates": [          0        ],        "type": "Point"      },      "radius": 0,      "hex_id": "string",      "applied_by": "string",      "applied_on": "string",      "suggested_by": "string",      "suggested_on": "string",      "order_handle": "string",      "source": "ht_generated",      "type": "manual",      "skew": 0,      "area_ratio": 0,      "centroid_shift": 0,      "inclusivity": "string"    }  ]}

{  "detail": {},  "message": "string"}

{  "detail": {},  "message": "string"}

{  "detail": {    "<location>": {      "<field_name>": [        "string"      ]    }  },  "message": "string"}

Authorization

Path Parameters

Query Parameters

Request Body

Response Body

200application/json

401application/json

404application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`