Skip to main content
POST
people.lists.upsert

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
kind
enum<string>
required

What the list holds: people profiles or companies.

Available options:
people,
companies
values
string[]
required

The members to add, at most 10 per call. Each is resolved to a record before it enters the list, and resolving people costs a small credit amount per matched profile (companies resolve cheaper) — see the pricing.

Required array length: 1 - 10 elements

For people, the member's LinkedIn profile URL; for companies, their website domain, e.g. example.com.

mode
enum<string>
default:append

Append to the list's members, or replace them all. Default append.

Available options:
append,
replace
ref
string

The ref returned by an earlier people.lists.upsert call.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

matched
integer
required

How many of the sent identifiers matched a record and entered the list.

Required range: 0 <= x <= 9007199254740991
unmatched
integer
required

How many matched nothing. Unmatched identifiers cost nothing to resolve.

Required range: 0 <= x <= 9007199254740991
listSize
integer

How many members the list holds now.

Required range: 0 <= x <= 9007199254740991
ref
string

Reference to what this call created. Pass it as ref to people.lists.upsert (to append or replace the same list).