View as Markdown

Remove Companies from List

POST/v2/companies/lists/remove

Takes companies out of one company list, by company id. They stay saved, and stay in their other lists. removed counts the companies that were in the list. Safe to repeat. Free: costs no credits.

Body parameters

  • list_idstringrequired

    The company list: an id from GET /v2/lists?type=companies.

  • idsstring[]required

    Company ids (24 hex characters, as POST /v2/companies/search answers them), 1-500.

Responses

  • 200 How many companies left the list.
  • 400 Invalid body (VALIDATION_ERROR with payload.code), or list_id is not a live company list of this workspace (VALIDATION_ERROR without payload).
  • 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
  • 429 Too many requests (RATE_LIMIT). Not sent today: this operation is not rate limited.
  • 500 Unexpected server error.

For error handling see Errors. Response objects are described in Person object and Company object.