Sign up for free
View as Markdown

Remove People from List

POST/v2/people/lists/remove

Takes people out of one people list. They stay saved, and stay in their other lists. removed counts the people who were in the list. Safe to repeat. Free: costs no credits.

Body parameters

  • list_idstringrequired

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

  • idsstring[]required

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

Responses

  • 200 How many people left the list.
  • 400 Invalid body (VALIDATION_ERROR with payload.code), or list_id is not a live people list of this workspace (invalid_value). Also when no id in ids is a well-formed person id (invalid_format).
  • 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.