Create Batch Add to List Job

POST

/v1/lists/batch-add-to-list-jobs

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.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Query Params

Body Params application/jsonRequired

Examples

Add companies to a company listAdd contacts to a contact list

{
    "data": {
        "type": "batch_add_to_list_job",
        "attributes": {
            "list_id": "company_123",
            "items": [
                {
                    "type": "company",
                    "id": "159001425"
                },
                {
                    "type": "company",
                    "id": "159001426"
                }
            ]
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Add companies to a company listAdd contacts to a contact list

curl --location 'https://api.leadfeeder.com/v1/lists/batch-add-to-list-jobs?account_id=123456' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "data": {
        "type": "batch_add_to_list_job",
        "attributes": {
            "list_id": "company_123",
            "items": [
                {
                    "type": "company",
                    "id": "159001425"
                },
                {
                    "type": "company",
                    "id": "159001426"
                }
            ]
        }
    }
}'

Responses

🟢202Accepted

application/json

Batch add-to-list job accepted and enqueued

Bodyapplication/json

Example

{
    "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"
                    },
                    {
                        "type": "company",
                        "id": "159001426"
                    }
                ]
            },
            "created_at": "2026-05-13T12:00:00Z"
        }
    },
    "meta": {
        "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

🟠429

🔴500Server Error

🔴504Gateway Timeout

Modified at 2026-07-24 17:02:53

Retrieve List Items

Get Batch Add to List Job