Update a Saved Location

Update (replace) an existing Saved Location.

Update (replace) a Saved Location

put

Authorizations

BearerAuth

AuthorizationstringRequired

Enter your PredictHQ API key. The Bearer prefix is added automatically.

When calling the API directly, send: 'Authorization: Bearer <YOUR_API_KEY>' as documented at https://docs.predicthq.com/api/overview/authenticating

Path parameters

location_idstringRequired

An existing Saved Location ID.

Body

application/json

location_codestringOptional

An optional identifier for your location.

The intention here is to use your own identifier for the location if you have one. E.g., you might have stores/hotels/etc in your system with their own ID

• use that ID here to make it easier to lookup the location later.

namestringOptional

Name of the Saved Location.

E.g. My Location

Example: My Location

descriptionstringOptional

Description of the location.

labelsstring[]Optional

A list of labels to help you categorize your locations. You can use these labels to search upon.

E.g.

  {
    "labels": ["label1", "label2"]
  }

Example: test

place_idsinteger[]Optional

You can define the geolocation of the Saved Location either by GeoJSON or Place IDs.

The Place IDs option is typically used when the location covers an entire city, county, state or country.

Use our Places API to search for the correct Place ID.

formatted_addressstringOptional

Responses

204

Successful Response

422

Validation Error

application/json

put

/v1/saved-locations/{location_id}

HTTPcURLJavaScriptPython

PUT /v1/saved-locations/{location_id} HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 277

{
  "location_code": "text",
  "name": "My Location",
  "description": "text",
  "labels": "test",
  "geojson": {
    "type": "Feature",
    "properties": {
      "radius": 3.17,
      "radius_unit": "mi"
    },
    "geometry": {
      "type": "Point",
      "coordinates": [
        -122.3816274,
        37.61911449999999
      ]
    }
  },
  "place_ids": [
    1
  ],
  "formatted_address": "text"
}

No content

Examples

curl

curl --location --request PUT 'https://api.predicthq.com/v1/saved-locations/5BcRstnNPjXl-fiB_0TQJg' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data '{
    "name": "S Las Vegas Blvd, Las Vegas (NV), US",
    "labels": [],
    "geojson": {
        "type": "Feature",
        "properties": {
            "radius": 1,
            "radius_unit": "mi"
        },
        "geometry": {
            "type": "Point",
            "coordinates": [
                -115.1728484,
                36.1147065
            ]
        }
    }
}'

python

OpenAPI Spec

The OpenAPI spec for Saved Locations API can be found here.

Guides

Below are some guides relevant to this API:

• Working with Location-Based Subscriptions