Company Lists

Add Companies To List

Changed on

Add companies to one of the team's company lists by their company IDs, the id of each company in a company search result. Returns the list with its new company count.

post/v0/company_lists/{list_id}/add_companies

Request

  • Base URL
    https://api.theirstack.com
  • URL
    https://api.theirstack.com/v0/company_lists/{list_id}/add_companies
  • Auth
    HTTP bearer

Path parameters

list_idinteger required

Request body

company_idsstring[]

Company IDs to add, the id of each company in a company search result

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' | 'INTERNAL_WEBHOOK_TRIGGERED' | 'CUSTOMER_CRM_SYNC'
webhook_idinteger nullable

Webhook ID of the list

customer_crm_connection_idinteger nullable

CRM connection that keeps this list in sync (CUSTOMER_CRM_SYNC lists)

Changes

  • 419602bcfbf6Revision changes
    • warning

      added the new CUSTOMER_CRM_SYNC enum value to the / response property for the response status

    • info

      added the optional property to the response with the status

  • acc7d199f39aRevision changes
    • warning

      added the new INTERNAL_WEBHOOK_TRIGGERED enum value to the / response property for the response status