---
title: "LocationServices_LocationManagement_CreateList"
method: POST
path: "/LocationServices/LocationManagement/CreateList/v1.10/json6.ws"
tags: ["LocationServices_LocationManagement_CreateList"]
---

# LocationServices_LocationManagement_CreateList

`POST /LocationServices/LocationManagement/CreateList/v1.10/json6.ws`

## Request

- Base URL: `https://api.addressy.com`
- URL: `https://api.addressy.com/LocationServices/LocationManagement/CreateList/v1.10/json6.ws`
- Auth: API key in query parameter `Key`

## Request body

- object
  - `Key` string, 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](https://account.loqate.com/account#/)).
  - `ListName` string: The name of the list being created.
  - `ListDescription` string: A description of the list being created.
  - `Locations` PointData[]: 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.**
    - `Name` string: The name of the location.
    - `Description` string: The description of the location for display purposes.
    - `Address` string: The address of the location for display purposes. **If Geocoding is set to TRUE then this parameter is mandatory.**
    - `Country` string: The ISO2 or ISO3 country code. **If Geocoding is set to TRUE then this parameter is mandatory.**
    - `Latitude` string: The WGS 84 latitude in decimal degrees format. This is mandatory unless Geocoding is set to TRUE.
    - `Longitude` string: The WGS 84 longitude in decimal degrees format. This is mandatory unless Geocoding is set to TRUE.
    - `MetaInfo` object: A key value pair that can be used to store any other relevant information. For example, this could be used to store contact information as 'ContactNumber': '123456789'
    - `UnstructuredMetaInfo` object
    - `OpeningHours` OpeningHours
      - `Monday` Day
        - `Open` string
        - `Close` string
        - `Information` string
      - `Tuesday` Day
        - `Open` string
        - `Close` string
        - `Information` string
      - `Wednesday` Day
        - `Open` string
        - `Close` string
        - `Information` string
      - `Thursday` Day
        - `Open` string
        - `Close` string
        - `Information` string
      - `Friday` Day
        - `Open` string
        - `Close` string
        - `Information` string
      - `Saturday` Day
        - `Open` string
        - `Close` string
        - `Information` string
      - `Sunday` Day
        - `Open` string
        - `Close` string
        - `Information` string
  - `CreatedOn` string, date-time, nullable
  - `LastModifiedOn` string, date-time, nullable
  - `Geocoding` boolean: A Boolean that determines whether the addresses passed in the locations object will be geocoded. Set to FALSE by default.

## Response `200`

Success

- object
  - `ListId` string: An automatically generated GuID used to uniquely identify a list.
  - `ListName` string: The name of the list passed in the request.
  - `ListDescription` string: The description of the list passed in the request.
  - `LatestRelatedListId` string
  - `IsErrorList` boolean
  - `Locations` ExternalResponsePointData[]: An array of strings that is populated with information about a location. Also contains a uniquely generated GuID per point.
    - `Id` string: The id of the location.
    - `Name` string: The name of the location.
    - `Description` string: The description of the location for display purposes.
    - `Address` string: The address of the location for display purposes.
    - `Country` string: The ISO2 or ISO3 country code.
    - `Latitude` string: The WGS 84 latitude in decimal degrees format.
    - `Longitude` string: The WGS 84 longitude in decimal degrees format.
    - `MetaInfo` object: A key value pair that can be used to store any other relevant information.
    - `UnstructuredMetaInfo` object
    - `OpeningHours` ExternalResponseOpeningHours
      - `Monday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
      - `Tuesday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
      - `Wednesday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
      - `Thursday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
      - `Friday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
      - `Saturday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
      - `Sunday` ExternalResponseDay
        - `Open` string
        - `Close` string
        - `Information` string
  - `CreatedOn` string, date-time, nullable: The date and time of when the list was initially created.
  - `LastModifiedOn` string, date-time, nullable: The date and time of when the list was last modified.

## Other responses

- `400`: BadRequest
- `401`: Unauthorized
- `403`: Forbidden
- `500`: InternalServerError

---

[API](https://skmtc.dev/loqate/apis/locationservices-locationmanagement-createlist.md) - [All operations](https://skmtc.dev/loqate/apis/locationservices-locationmanagement-createlist/llms.txt) - [OpenAPI document](https://skmtc.dev/loqate/apis/locationservices-locationmanagement-createlist/revisions/894919a6bb5d?raw)