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; its prefix (company_ or contact_) determines whether company or contact references are accepted. You need permission to change the list's members, and it can't be a read-only list, such as a revealed, CRM or custom feed list. The members are supplied either as an explicit data.attributes.items array (up to 100 items per request), or — for company lists only — as a data.attributes.advanced_search selection that is resolved into companies (up to 100,000) when the job runs. A list holds at most 1,000,000 members. 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 outcome: per-item results plus summary counts for items jobs, summary counts only for jobs created from a search selection.

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 listAdd the companies matching an advanced search to a company list

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢202Accepted

application/json

Batch add-to-list job accepted and enqueued

Bodyapplication/json

Example

{
    "data": {
        "attributes": {
            "configuration": {
                "items": [
                    {
                        "id": "159001425",
                        "type": "company"
                    },
                    {
                        "id": "159001426",
                        "type": "company"
                    }
                ],
                "list_id": "company_123"
            },
            "created_at": "2026-05-13T12:00:00Z",
            "status": "running"
        },
        "id": "job_550e8400-e29b-41d4-a716-446655440000",
        "type": "batch_add_to_list_job"
    },
    "meta": {
        "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

🟠429

🔴500Server Error

🔴504Gateway Timeout