Skip to main content
POST
Create an entity list, mirroring GraphQL `createEntityList`.

Authorizations

x-api-key
string
header
required

Body

application/json
kind
enum<string>
required
Available options:
PERSON,
COMPANY,
NOTE,
ACTIVITY,
FILE,
TASK,
OPPORTUNITY
name
string
required
description
string | null
entity_uuids
string[] | null

UUIDs to add as members of the list on creation (optional).

uuid
string | null

Client-supplied UUID for the new list (optional).

Response

201 - application/json

A named collection of companies or persons.

created_at
string
required
description
string | null
required
entities_count
integer
required
kind
string
required
name
string
required
owner_uuid
string
required
updated_at
string
required
uuid
string
required