People

Trigger enrichment for a person

Use this endpoint to trigger Atlas' background enrichment for an existing person — the REST equivalent of Sync profile in the Atlas UI.

This endpoint is asynchronous. It returns 202 Accepted as soon as the job is queued and does not wait for the enrichment to finish; enrichment can take from seconds to minutes. Poll GET /api/v1/people/{id} and read enrichmentStatus (in_progress → completed or failed) to find out when it is done, then re-read the person to see the new data. The list endpoint GET /api/v1/people does not return enrichmentStatus.

Enrichment types (optional type in the body):

  • contacts (default) — looks up email addresses and phone numbers from the person's public LinkedIn profile and adds them as identities. Existing identities are never overwritten. Requires a public LinkedIn profile URL on the person.
  • full — runs the complete CES profile sync: work experience, headline, and identities. Requires a LinkedIn URL or both a first and last name.

Usage. Both types count towards your agency's enrichment usage exactly as the equivalent actions in the Atlas UI do; this endpoint is not capped separately from the app. Automated loops can burn through enrichments quickly — enrich deliberately rather than on every sync pass.

Re-triggering. While a person's enrichmentStatus is in_progress, a second call is rejected with 422. Wait for it to settle before calling again.

Side effects. Enrichment adds and merges identities and experiences on the person. Conflicting values are skipped, never overwritten, and adding an experience recalculates the person's headline.

post/api/v1/people/{id}/enrich

Path parameters

idstring uuid required

Atlas person ID

Example:123e4567-e89b-12d3-a456-426614174000

Request body

type'full' | 'contacts'

Which enrichment to run. contacts (default) looks up email/phone from the LinkedIn profile; full runs the complete CES profile sync (experiences, headline, identities).

Example request

{
  "type": "contacts"
}

Response

Enrichment queued. Poll GET /api/v1/people/{id} for enrichmentStatus.

status'ok' required

Example response

{
  "data": {
    "type": "contacts"
  }
}

Changes

Changed in 1 of the 6 revisions of this API.1