Location Management: Delete List or Point

Permanently delete location lists or individual points using management keys. Deletions cannot be recovered once completed.

POST /LocationServices/LocationManagement/DeleteListOrPoint/v1.10/json6.ws

LocationServices_LocationManagement_DeleteListOrPoint

cURL

curl --request POST \
  --url 'https://api.addressy.com/LocationServices/LocationManagement/DeleteListOrPoint/v1.10/json6.ws?Key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Key": "AA11-AA11-AA11-AA11",
  "listId": "<string>",
  "locationID": "<string>"
}
'

200

Example

{
  "Message": "<string>",
  "Id": "<string>"
}

This endpoint requires the use of a Loqate Management key. Management keys are used to provide access to server-side functions in place of your standard API key, ensuring that were any of your keys to be scraped from a customer facing website, they could not be used to edit or delete your Location Lists. For information on how to create a Management key please see the Setting Up Store Finder Keys guide.

The Delete List or Point API allows you to delete an existing list created using our Create List endpoint.

NOTE: any lists deleted via this endpoint are deleted permanently. We do not back up location lists.

Authorizations

Key · string · query · required

Body

application/json

Key · string · default: AA11-AA11-AA11-AA11 · required

The key you want to use to authenticate with the service (you can request we create one for you or create one in your account section).

listId · string

The unique GUID for a given list.

locationID · string

The unique GUID for a given location.

Response

200

application/json

Success

Message · string

A message detailing how the operation performed.

Id · string

The GUID of the list or location deleted.