Pool

Build a lead list from the pool

Enqueues a build and returns a job handle immediately — no HTTP request ever spans this work, so there is nothing to time out. Poll GET /v1/pool/jobs/{id} for progress.

max_contacts is required and is the point of the endpoint. The build is refused if the filter's exact count exceeds it, so you cannot enqueue a four-million-contact build by leaving a parameter out — you have to state the number and mean it. The hard ceiling is 250,000 regardless.

Give either list_id to append to an existing list, or list_name to create one. The destination is resolved before the size gate runs, so a rejected build never leaves an empty list behind.

post/v1/pool/lists

Request

  • Base URL: https://api.automatedclientacquisition.com
  • URL: https://api.automatedclientacquisition.com/v1/pool/lists
  • Auth: HTTP bearer

Request body

filterobject required

Same shape as /v1/pool/search, byte for byte.

max_contactsinteger required

Ceiling on this build. Refused if the exact count is higher.

list_idstring uuid

Append to this existing list.

list_namestring

Create a new list with this name instead.

descriptionstring

Response

Build accepted. The work happens on the next worker tick.

successboolean
list_idstring uuid
matchedinteger

Example response

{
  "success": true,
  "matched": 4820
}

Changes

No recorded changes to this operation across all 1 revision of this API.