v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB

Manage POIs

Update Custom POI

The Update POI service can be used to update any of your <<glossary:Custom POI>>s, by providing any combination of the following custom POI’s properties(at least one):<br/> <ol> <li>Name - the POI’s name.</li> <li>Area - can be defined either by determining the centroid (lng, lat) and the radius to create the POI area, or by a list of all polygon GEO points (lng,lat).</li> <li>Sub-category (For available sub-categories, see <a href="https://view-su2.highspot.com/viewer/87b4c810b4bc52f78f8fd2862fdf31dd">listed categories</a>.</li> <li>Address - the consumer can change any of the following properties: street address, city and/or zipcode.</li> </ol>

put/v1/poi/custom-poi/{id}

Path parameters

idstring required

Placer API ID

Request body

idstring

centroidnumber[]

List of 2 values that represents the GEO location of the POI center

radiusnumber float

Radius (in miles) with which the polygon is constructed when the center of the polygon is the centroid

Example request

{
  "id": "complex:5f7a2d2dc2b5e82a0114cf62",
  "centroid": [
    -78.519444,
    36.61636
  ],
  "polygon": [
    [
      -78.51961433887482,
      36.61628975092374
    ],
    [
      -78.51927638053894,
      36.61628975092374
    ],
    [
      -78.51927638053894,
      36.616430763747964
    ],
    [
      -78.51961433887482,
      36.616430763747964
    ],
    [
      -78.51961433887482,
      36.61628975092374
    ]
  ],
  "address": {
    "address": "301 Ranch Dr",
    "city": "Milpitas",
    "zipCode": "95035"
  }
}

Response

200 response

Example response

{
  "data": {
    "result": "SUCCESS",
    "name": "Name to be used to identify the <<glossary:Custom POI>>",
    "apiId": "complex:8d22ae197ee335c5074a67ff"
  }
}