Sign in

v10

latestOpenAPI 3.1.02026-08-0452108384.4 KB
Company Lists

Add Companies To List

post/v0/company_lists/{list_id}/add_companies

Path parameters

list_idinteger required

Request body

company_idsstring[]

Company IDs (encrypted slugs) to add to the list

company_namesstring[]

Company names to add to the list. Please don't use this filter anymore, use the company_ids filter instead.

Example request

{
  "company_ids": [
    "jzZtZUAlXO/EX2wK4o6/Jw=="
  ]
}

Response

Successful Response

namestring required

Name of the company list

idinteger required
created_atstring date-time required
deletableboolean nullable

Whether the list can be deleted

companies_countinteger

Number of companies in the list

user_idinteger nullable

User ID of the list owner

type'REVEALED_COMPANIES' | 'WEBHOOK_TRIGGERED' | 'MANUAL_CREATION' | 'EXPORT_SNAPSHOT'
webhook_idinteger nullable

Webhook ID of the list