v1

latestOpenAPI 3.1.0Proprietary2026-07-265759203.4 KB

Create Exclusion List Endpoint

Create an exclusion list (asynchronous materialization).

Lists are immutable in v1: to change one, create a new list and delete the old. Up to 20 active lists per organization (40 for organizations with extended exclusion limits).

post/search/exclusion-lists

Headers

x-api-keystring nullable

Request body

namestring nullable

Required unless source.type is 'search_id' (defaults to a date-stamped name).

entity_type'person' | 'company'

Example request

{
  "name": "Existing customers",
  "source": {
    "id_column": "linkedin_url",
    "resource_handle_id": "8f14e45f-...",
    "type": "resource_handle"
  }
}

Response

Successful Response

idstring required

Exclusion list ID; poll GET /search/exclusion-lists/{id} until ready.

statusstring required

Initial status, always 'pending'.