Skip to main content
POST
/
v1
/
lists
Create a list
curl --request POST \
  --url https://openapi.enginy.ai/v1/lists \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": "CONTACTS",
  "name": "<string>",
  "description": "<string>",
  "folderId": 123
}
'
{
  "status": "success",
  "message": "<string>",
  "data": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "type": "CONTACTS",
    "entitiesCount": 123,
    "createdBy": {
      "id": 123,
      "name": "<string>"
    },
    "createdAt": "2023-12-25"
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
type
enum<string>
required

Type of list to create (CONTACTS or COMPANIES).

Available options:
CONTACTS,
COMPANIES
​
name
string
required

Name of the list

Minimum string length: 1
​
description
string | null

Description of the list

​
folderId
integer | null

Folder ID to place the list in

Response

List created successfully

​
status
enum<string>
required
Available options:
success
​
message
string
required
​
data
object
required