View as Markdown

Save People

POST/v2/people/save

Saves up to 500 people into 1-20 of your v2 lists, by GetProspect id or by LinkedIn profile URL (at most 50 URL items). Credits: 1 email credit per person whose stored valid email your workspace does not own yet; when the balance runs out the rest are saved without email, and that email stays billable on a later save, enrich or search. A person already paid for is free to save again. Uses 1 unit of the enrich rate limit per linkedin_url item (none for one your workspace already owns); id items use none. Every item comes back in one of saved, not_matched, invalid or failed, echoing its identifier.

Body parameters

  • dataone of[]required

    People to save (1-500): person id strings or items with exactly one of id / linkedin_url (at most 50 linkedin_url items).

  • list_idsstring[]required

    v2 list ids to attach every saved person to (1-20).

    Example
    {
      "list_ids": [
        "64f1a2b3c4d5e6f7a8b9c0f1"
      ]
    }

Responses

  • 200 Every item in one of the four buckets; metadata.credits is the balance after the save.
  • 400 Invalid request (VALIDATION_ERROR; payload.code says which kind of mistake), or list_ids naming a list that is not a v2 list of your workspace.
  • 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
  • 402 Your email credit balance is zero (PAYMENT_REQUIRED).
  • 429 Over the enrich rate limit (RATE_LIMIT); wait Retry-After seconds. Sent only where rate limits are enforced.
  • 500 Unexpected server error.

For error handling see Errors. Response objects are described in Person object and Company object.