Contact Tables

Add Entities to Contacts Table

Add up to 500 contact IDs to an existing table. entityIds accepts either the encrypted Lusha token (v{N}.…, as returned by Search/Enrich/Get Entities) or the legacy numeric personId - an ID that’s neither returns 400. Already-present IDs are reported as alreadyPresent and not re-added; unresolvable IDs are not an error, they come back in invalidIds with a 200.

Optionally pass companyIds - one lushaCompanyId per contact, index-aligned with entityIds - to help pair company-level enrichment to the right company for each contact.

Billing: Free.

POST

contacts

tables

{table_id}

entities

Add Entities to Contacts Table

curl --request POST \
  --url https://api.lusha.com/v3/contacts/tables/{table_id}/entities \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "entityIds": [
    "10042854",
    "10042855",
    "10042856"
  ],
  "companyIds": [
    "16303253",
    "16303253",
    "12790225"
  ],
  "owner": {
    "email": "user@example.com"
  }
}
'

import requests

url = "https://api.lusha.com/v3/contacts/tables/{table_id}/entities"

payload = {
    "entityIds": ["10042854", "10042855", "10042856"],
    "companyIds": ["16303253", "16303253", "12790225"],
    "owner": { "email": "user@example.com" }
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entityIds: ['10042854', '10042855', '10042856'],
    companyIds: ['16303253', '16303253', '12790225'],
    owner: {email: 'user@example.com'}
  })
};

fetch('https://api.lusha.com/v3/contacts/tables/{table_id}/entities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.lusha.com/v3/contacts/tables/{table_id}/entities")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entityIds\": [\n    \"10042854\",\n    \"10042855\",\n    \"10042856\"\n  ],\n  \"companyIds\": [\n    \"16303253\",\n    \"16303253\",\n    \"12790225\"\n  ],\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  }\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lusha.com/v3/contacts/tables/{table_id}/entities"

	payload := strings.NewReader("{\n  \"entityIds\": [\n    \"10042854\",\n    \"10042855\",\n    \"10042856\"\n  ],\n  \"companyIds\": [\n    \"16303253\",\n    \"16303253\",\n    \"12790225\"\n  ],\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "added": 20,
    "alreadyPresent": 5,
    "invalidIds": [],
    "addedBy": {
      "surface": "api"
    }
  },
  "billing": {
    "creditsCharged": 3,
    "resultsReturned": 1
  }
}

Authorizations

api_key

string

header

required

Your Lusha API key. You can find this in your Lusha dashboard under API settings. Include this key in the api_key header for all requests.

Path Parameters

table_id

string

required

The table's ID.

Body

application/json

entityIds

string[]

required

Lusha IDs as strings - personId for contacts, lushaCompanyId for companies. Accepts either the encrypted token (v{N}.…, as returned by Search/Enrich/Get Entities) or the legacy numeric ID. An ID that is neither a valid token nor numeric returns 400.

Maximum array length: 500

Example:

["10042854", "10042855", "10042856"]

owner

object

required

Identifies the user acting on the table, and resolves to a user on your account. Required on every table-route call when authenticating with an API key (there is no signed-in user) - omitting it returns 400. Optional for OAuth/token callers, since the caller is already identified by the token; still accepted if you want to act on behalf of another owner.

Show child attributes

companyIds

string[]

Contacts tables only. One lushaCompanyId per contact (encrypted token or numeric), index-aligned with entityIds, to help pair company-level enrichment to the right company for each contact. Ignored on companies tables.

Example:

["16303253", "16303253", "12790225"]

Response

Entities added

data

object

Show child attributes

billing

object

Credit usage summary for a V3 API request

Show child attributes

⌘I

Add Entities to Contacts Table

curl --request POST \
  --url https://api.lusha.com/v3/contacts/tables/{table_id}/entities \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "entityIds": [
    "10042854",
    "10042855",
    "10042856"
  ],
  "companyIds": [
    "16303253",
    "16303253",
    "12790225"
  ],
  "owner": {
    "email": "user@example.com"
  }
}
'

import requests

url = "https://api.lusha.com/v3/contacts/tables/{table_id}/entities"

payload = {
    "entityIds": ["10042854", "10042855", "10042856"],
    "companyIds": ["16303253", "16303253", "12790225"],
    "owner": { "email": "user@example.com" }
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entityIds: ['10042854', '10042855', '10042856'],
    companyIds: ['16303253', '16303253', '12790225'],
    owner: {email: 'user@example.com'}
  })
};

fetch('https://api.lusha.com/v3/contacts/tables/{table_id}/entities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.lusha.com/v3/contacts/tables/{table_id}/entities")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entityIds\": [\n    \"10042854\",\n    \"10042855\",\n    \"10042856\"\n  ],\n  \"companyIds\": [\n    \"16303253\",\n    \"16303253\",\n    \"12790225\"\n  ],\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  }\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lusha.com/v3/contacts/tables/{table_id}/entities"

	payload := strings.NewReader("{\n  \"entityIds\": [\n    \"10042854\",\n    \"10042855\",\n    \"10042856\"\n  ],\n  \"companyIds\": [\n    \"16303253\",\n    \"16303253\",\n    \"12790225\"\n  ],\n  \"owner\": {\n    \"email\": \"user@example.com\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "added": 20,
    "alreadyPresent": 5,
    "invalidIds": [],
    "addedBy": {
      "surface": "api"
    }
  },
  "billing": {
    "creditsCharged": 3,
    "resultsReturned": 1
  }
}

Overview

Resources

Endpoints

Add Entities to Contacts Table

Authorizations

Path Parameters

Body

Response