v3

OpenAPI 3.1.1mit2026-07-3165481.5 MB
Lists
v1

Create Batch Remove from List Job

Schedule an asynchronous job that removes members from a single list. The target list is identified by data.attributes.list_id in the request body; the list's list_type determines whether company or contact references are accepted. Up to 100 items may be supplied per request. To add members, use POST /v1/lists/batch-add-to-list-jobs — adding and removing are separate jobs.

Returns 202 Accepted with a job handle. Poll GET /v1/lists/batch-remove-from-list-jobs/{job_id} to observe progress and the per-item outcome.

Credit Note: Removing members from a list does not consume credits.

:::info Requires the lists:write OAuth2 scope. :::

post/v1/lists/batch-remove-from-list-jobs

Query parameters

account_idstring required

The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.

Request body

Example request

{
  "data": {
    "type": "batch_remove_from_list_job",
    "attributes": {
      "list_id": "contact_456",
      "items": [
        {
          "type": "contact",
          "id": "3170656125"
        },
        {
          "type": "contact",
          "id": "3219787635"
        }
      ]
    }
  }
}

Response

Batch remove-from-list job accepted and enqueued

Example response

{
  "data": {
    "type": "batch_remove_from_list_job",
    "id": "job_7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "attributes": {
      "status": "running",
      "configuration": {
        "list_id": "contact_456",
        "items": [
          {
            "type": "contact",
            "id": "3170656125"
          }
        ]
      },
      "results": [
        {
          "id": "3170656125",
          "type": "contact",
          "status": "removed"
        }
      ],
      "summary": {
        "removed": 2,
        "list_size_after": 49
      },
      "errors": [
        {
          "code": "job_failed",
          "title": "External contact data provider timeout"
        }
      ],
      "created_at": "2026-05-13T12:00:00Z",
      "completed_at": "2026-05-13T12:00:18Z"
    }
  },
  "meta": {
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}