Skip to main content
POST
Create list

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Body

application/json
name
string
required

List name (required).

Minimum string length: 1
list_type
enum<string>
default:persons

Type of entities in this list. Defaults to "persons".

Available options:
persons,
companies
is_public
boolean
default:false

Whether the list is visible to all team members. Defaults to false.

linked_job_id
string<uuid>

Job UUID to link this list to.

linked_person_id
string<uuid>

Person UUID to link this list to.

linked_organization_company_id
string<uuid>

Company UUID to link this list to.

owner_ids
string<uuid>[]

Team member UUIDs to assign as list owners. If omitted, the caller is auto-assigned.

team_member_id
string<uuid>

Team member UUID to attribute as the list creator. Required for API-key auth (which has no implicit user context). Ignored when using session or OAuth auth.

Response

List created

success
enum<boolean>
required
Available options:
true
data
object
required