Skip to main content
POST
/
LocationServices
/
LocationManagement
/
UpdateListOrPoint
/
v1.10
/
json6.ws
cURL
curl --request POST \
  --url https://api.addressy.com/LocationServices/LocationManagement/UpdateListOrPoint/v1.10/json6.ws \
  --header 'Content-Type: application/json' \
  --data '{
  "Key": "<string>",
  "ListId": "<string>",
  "ListName": "<string>",
  "LatestRelatedListId": "<string>",
  "IsErrorList": true,
  "ListDescription": "<string>",
  "Locations": [
    {
      "Id": "<string>",
      "Name": "<string>",
      "Description": "<string>",
      "Address": "<string>",
      "Country": "<string>",
      "Latitude": "<string>",
      "Longitude": "<string>",
      "MetaInfo": {},
      "UnstructuredMetaInfo": {},
      "OpeningHours": {
        "Monday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Tuesday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Wednesday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Thursday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Friday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Saturday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Sunday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        }
      }
    }
  ],
  "CreatedOn": "2023-11-07T05:31:56Z",
  "LastModifiedOn": "2023-11-07T05:31:56Z",
  "Geocoding": true
}'
{
  "ListId": "<string>",
  "ListName": "<string>",
  "LatestRelatedListId": "<string>",
  "IsErrorList": true,
  "ListDescription": "<string>",
  "Locations": [
    {
      "Id": "<string>",
      "Name": "<string>",
      "Description": "<string>",
      "Address": "<string>",
      "Country": "<string>",
      "Latitude": "<string>",
      "Longitude": "<string>",
      "MetaInfo": {},
      "UnstructuredMetaInfo": {},
      "OpeningHours": {
        "Monday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Tuesday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Wednesday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Thursday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Friday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Saturday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Sunday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        }
      }
    }
  ],
  "CreatedOn": "2023-11-07T05:31:56Z",
  "LastModifiedOn": "2023-11-07T05:31:56Z"
}
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 Update List or Point API allows you to update an existing list created using our Create List endpoint. When updating a list or point, any fields left null will retain their original information. To add new points to a list, only supply the new values - the existing points will be unaffected. You can add a maximum of 100 points to an existing list per request.

Body

application/json
​
Key
string
default:AA11-AA11-AA11-AA11
required

The Loqate Management key used to authenticate with the service. For example: 'AA11-AA11-AA11-AA11'.

​
ListId
string | null

The unique GuID for a given list.

​
ListName
string | null

The name of the list being created.

​
LatestRelatedListId
string | null
​
IsErrorList
boolean
​
ListDescription
string | null

A description of the list being created.

​
Locations
object[] | null

An array of strings that is populated with information about a location. If latitude and longitude are blank then Geocoding must be set to true.

​
CreatedOn
string<date-time> | null
​
LastModifiedOn
string<date-time> | null
​
Geocoding
boolean

Response

Success

​
ListId
string | null

Automatically generated GuID used to uniquely identify a list.

​
ListName
string | null

The name of the list passed in the request.

​
LatestRelatedListId
string | null
​
IsErrorList
boolean
​
ListDescription
string | null

The description of the list passed in the request.

​
Locations
object[] | null

An array of strings that is populated with information about a location. Also contains a uniquely generated GuID per point.

​
CreatedOn
string<date-time> | null

The date and time of when the list was initially created.

​
LastModifiedOn
string<date-time> | null

The date and time of when the list was last modified.

⌘I