v3

latestOpenAPI 3.1.1mit2026-07-3165481.5 MB
Lists
v1

Create Batch Add to List Job

Schedule an asynchronous job that adds members to 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 remove members, use POST /v1/lists/batch-remove-from-list-jobs — adding and removing are separate jobs.

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

Credit Note: Adding members to a list does not consume credits.

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

post/v1/lists/batch-add-to-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_add_to_list_job",
    "attributes": {
      "list_id": "company_123",
      "items": [
        {
          "type": "company",
          "id": "159001425"
        },
        {
          "type": "company",
          "id": "159001426"
        }
      ]
    }
  }
}

Response

Batch add-to-list job accepted and enqueued

Example response

{
  "data": {
    "type": "batch_add_to_list_job",
    "id": "job_550e8400-e29b-41d4-a716-446655440000",
    "attributes": {
      "status": "running",
      "configuration": {
        "list_id": "company_123",
        "items": [
          {
            "type": "company",
            "id": "159001425"
          }
        ]
      },
      "results": [
        {
          "id": "159001425",
          "type": "company",
          "status": "added"
        }
      ],
      "summary": {
        "added": 2,
        "list_size_before": 51,
        "list_size_after": 53
      },
      "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"
  }
}