HYhypertrack
Places

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.

patch/places/v1/{place_handle}

Request

Path parameters

place_handlestring required

Query parameters

update_associated_ordersboolean nullable

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

update_geometry_using_addressboolean nullable

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

Request body

place_handlestring nullable

Human friendly handle of place

namestring nullable

Human readable name of the place

radiusinteger nullable

Radius of geofence in case geometry is a Point

addressstring nullable

Address associated with the place

metadataobject nullable

Metadata - any additional data in form of json

closed_onstring[] nullable

Dates when this place will be closed

expected_service_timeinteger nullable

Expected service/work time at this place

detect_visitsboolean nullable

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_idstring nullable

UUID of the associated geofence.

place_type'shop' | 'house' | 'restaurant' | 'office' | 'warehouse' | 'hospital' | 'mall' | 'university' | 'golf_course' | 'stadium' | 'airport' | 'null' nullable

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

TypeMax AreaApprox. SizeDescription
shop5,000 m²~71m x 71mSmall retail shop or store
house2,000 m²~45m x 45mResidential house or apartment
restaurant5,000 m²~71m x 71mRestaurant, cafe, or eatery
office10,000 m²~100m x 100mOffice building or coworking space
warehouse50,000 m²~224m x 224mWarehouse or distribution center
hospital100,000 m²~316m x 316mHospital or large medical facility
mall200,000 m²~447m x 447mShopping mall or large retail complex
university5,000,000 m²~2.2km x 2.2kmUniversity or large campus
golf_course8,000,000 m²~2.8km x 2.8kmGolf course or large sports complex
stadium1,000,000 m²~1.0km x 1.0kmStadium or arena with parking
airport8,000,000 m²~2.8km x 2.8kmAirport or airfield

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

suggestion_usedboolean nullable

If the geofence is applied using inferred geofence or bounding box

suggestion_idstring nullable

Id of the suggestion used to update the geofence

locked_from_suggestionsboolean nullable

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

suggestions_reviewed_onstring nullable

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

Response

Successful response

place_handlestring nullable

Human friendly handle of places

namestring nullable

Human readable name of the place

radiusinteger nullable

Radius of geofence in case geometry is a Point

addressstring nullable

Address associated with the place

metadataobject nullable

Metadata - any additional data in form of json

closed_onstring[] nullable

Dates when this place will be closed

expected_service_timeinteger nullable

Expected service/work time at this place

detect_visitsboolean nullable

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_idstring nullable

UUID of the associated geofence.

place_type'shop' | 'house' | 'restaurant' | 'office' | 'warehouse' | 'hospital' | 'mall' | 'university' | 'golf_course' | 'stadium' | 'airport' | 'null' nullable

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

TypeMax AreaApprox. SizeDescription
shop5,000 m²~71m x 71mSmall retail shop or store
house2,000 m²~45m x 45mResidential house or apartment
restaurant5,000 m²~71m x 71mRestaurant, cafe, or eatery
office10,000 m²~100m x 100mOffice building or coworking space
warehouse50,000 m²~224m x 224mWarehouse or distribution center
hospital100,000 m²~316m x 316mHospital or large medical facility
mall200,000 m²~447m x 447mShopping mall or large retail complex
university5,000,000 m²~2.2km x 2.2kmUniversity or large campus
golf_course8,000,000 m²~2.8km x 2.8kmGolf course or large sports complex
stadium1,000,000 m²~1.0km x 1.0kmStadium or arena with parking
airport8,000,000 m²~2.8km x 2.8kmAirport or airfield

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

place_idstring uuid nullable

Id of place

last_updatedstring nullable

Time when this place was last updated

order_countinteger nullable

Order Count for this place

inferred_geofences_skewnumber nullable

Skew in inferred geofence, values can be between 0 and 1. 0 mean no skew, i.e. perfect overlap and 1 means no overlap

locked_from_suggestionsboolean nullable

Whether this place is locked from receiving future suggestions

suggestion_appliedboolean nullable

Whether a suggestion was applied to this place

suggestion_applied_onstring nullable

Timestamp when a suggestion was applied to this place

has_pending_suggestionboolean nullable

Whether this place has a pending suggestion

suggestion_not_applied_reasonstring nullable

Reason why suggestion was not applied, if applicable

suggestions_reviewed_onstring nullable

Timestamp when suggestions were last reviewed for this place

Changes

No recorded changes to this operation across all 1 revision of this API.