Location Management: Update List or Point

Update location lists or individual points with new information. Add up to 100 new points per request while preserving existing location data.

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

LocationServices_LocationManagement_UpdateListOrPoint

cURL

curl --request POST \
  --url 'https://api.addressy.com/LocationServices/LocationManagement/UpdateListOrPoint/v1.10/json6.ws?Key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Key": "AA11-AA11-AA11-AA11",
  "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
}
'

200

Example

{
  "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.

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.

ListName · string

The name of the list being updated or created.

LatestRelatedListId · string

IsErrorList · boolean

ListDescription · string

A description of the list being updated or created.

Locations · object[]

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.

Show child attributes

CreatedOn · string<date-time> | null

LastModifiedOn · string<date-time> | null

Geocoding · boolean

Response

200

application/json

Success

ListId · string

Automatically generated GuID used to uniquely identify a list.

ListName · string

The name of the list passed in the request.

LatestRelatedListId · string

IsErrorList · boolean

ListDescription · string

The description of the list passed in the request.

Locations · object[]

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

Show child attributes

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.