Delete POIs
Delete Request
POIs can be deleted via a DELETE
request to the POI API endpoint. The data should be provided as a JSON in the body of the request and not in the URL.
JSON
DELETE https://api.naurt.net/poi/v3
Content-Type: application/json
Authorization: <API_KEY_HERE>
{
"poi_ids": list[String]
}
CURL
curl -X DELETE https://api.naurt.net/poi/v3 \
-H "Content-Type: application/json" \
-H "Authorization: <API_KEY_HERE>" \
-d '{"poi_ids":["some_id_here"]}'
Delete Parameters
Parameter | Type | Optional | Default | Description |
---|---|---|---|---|
poi_ids | ListString | No | None | A list of POI IDs conforming to UUID v4 which you wish to be deleted. |
Delete Response
A response will be formatted as a JSON whether successful or not. If successful, you will be told as such and receive the count of POIs deleted.
Success
A 200
response code indicates a successful response and will look as follows.
{"naurt_info":"Successful POI Deletion","number_deleted":2}
Failure
A response code other than 200
indicates a failure to delete the requested POIs.
JSON
401 Unauthorized
{"error":"Please ensure the request contains a valid API key."}
Delete Restrictions
The deletion of POIs currently has some restrictions.
- A maximum of 25 POIs can be deleted in one request.
- A maximum of 300 requests per minute can be sent to the POI API endpoint from a single API key.
Delete Example
JSON
DELETE https://api.naurt.net/poi/v3
Content-Type: application/json
Authorization: <API_KEY_HERE>
{
"poi_ids": ["c8c09820-5c1d-4892-b673-961f60989820", "d25abe02-7e29-4218-8862-097d2a7042cf"]
}