Skip to main content
POST
Add or Remove Companies in a List
Adds existing CRM companies to a static company list, or removes them when you set ?action=remove. The list must be a static company list (clt_xxx); dynamic lists (auto-populated by filter rules) and contact lists are rejected.
Removal uses POST ?action=remove, not DELETE. A DELETE request body is dropped by our stack, so DELETE on this path is not supported and returns 405 Method Not Allowed.
Removing a company from a list only affects list membership — it does not delete the company from your CRM.

Add vs remove

Typical workflow

  1. Find or create a list — use GET /companies/lists to find an existing static list, or POST /companies/lists to create one (clt_xxx).
  2. Find companies — use GET /companies with search or listId to get company IDs (cpn_xxx).
  3. Add or remove — call this endpoint with the company IDs and list ID. Up to 1,000 companies per request.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

listId
string
required

The unique identifier of the company list (clt_xxx format). Must be a static company list.

Pattern: ^clt_[a-zA-Z0-9]+$

Query Parameters

action
enum<string>

Omit to add the companies to the list. Set to remove to remove them from the list.

Available options:
remove

Body

application/json
companyIds
string[]
required

Array of company IDs (cpn_xxx format) to add to or remove from the list. Required, non-empty, maximum 1,000 per request.

Required array length: 1 - 1000 elements
Pattern: ^cpn_[a-zA-Z0-9]+$

Response

Companies added to or removed from the list successfully. The response body depends on action.

message
string
addedCount
integer

Number of companies added to the list (add only).

alreadyInList
integer

Number of companies that were already in the list and therefore skipped (add only).

removedCount
integer

Number of list associations actually removed (remove only). Companies that were not in the list are not counted.