Skip to main content
POST
/
lists
cURL
curl --request POST \
  --url https://public-api.lonescale.com/lists \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "My Target Accounts",
  "entity": "COMPANY"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "entity": "COMPANY",
  "description": "<string>",
  "organizationId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Provide your API key in the x-api-key header.

Body

application/json
​
name
string
required

Name of the list.

​
entity
enum<string>
required

Entity type the list will hold.

Available options:
COMPANY,
PEOPLE

Response

The created list

​
id
string<uuid>

Unique identifier of the list.

​
name
string

Name of the list.

​
entity
enum<string>

The entity type of the list.

Available options:
COMPANY,
PEOPLE
​
description
string

Description of the list.

​
organizationId
string

The organization this list belongs to.

​
createdAt
string<date-time>

Creation timestamp.

​
updatedAt
string<date-time>

Last update timestamp.