Add items

{
    "items": [
        { "countryCode": "BE", "companyId": "1778186251" }
    ]
}

{
    "success": true,
    "failed": [],
    "message": "Successfully added 1 item(s) to the list."
}

PUT

lists

{listId}

results

{
    "items": [
        { "countryCode": "BE", "companyId": "1778186251" }
    ]
}

{
    "success": true,
    "failed": [],
    "message": "Successfully added 1 item(s) to the list."
}

Adds items to a list. The shape of each item in the items array must match the list’s objectType. Sending the wrong shape (e.g. a contact item to a company list) returns 400. You can add up to 100 items per request.

Request

Path

string

required

Obfuscated listId returned by the overview endpoint.

Body

object[]

required

Up to 100 items to add. The item shape depends on the list’s objectType:

COMPANY — { "countryCode": "BE", "companyId": "1778186251" }
LEGAL_ENTITY — { "legalEntityId": "998877", "countryCode": "BE" } (countryCode is optional)
CONTACT — { "company": { "countryCode": "BE", "companyId": "1778186251" }, "contactIdentifier": { "contactId": "123456" } }

{
    "items": [
        { "countryCode": "BE", "companyId": "1778186251" }
    ]
}

Response

boolean

true when at least one item was added successfully.

object[]

Items that could not be added, each with the original item and a message explaining why (e.g. Company not found, Invalid contactId).

{
    "success": true,
    "failed": [],
    "message": "Successfully added 1 item(s) to the list."
}

Getting Started

V2 API

V1 API

Request

Path

Body

Response

​Request

​Path

​Body

​Response

Request

Path

Body

Response