Enrich people

Webhook result: Documentation

Quickstart#

curl -X POST "https://api.ocean.io/v2/enrich/people" \
  -H "X-Api-Token: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "peopleDataMapping": {
      "contact-001": { "person": { "linkedin": "linkedin.com/in/jane-doe-123" } },
      "contact-002": {
        "person": { "firstName": "John", "lastName": "Smith", "jobTitle": "CTO" },
        "company": { "domain": "acme.com" }
      },
      "contact-003": { "person": { "id": "ocean-person-id-abc" } }
    },
    "webhookUrl": "https://yourapp.com/webhooks/ocean-people"
  }'

import requests

response = requests.post(
    'https://api.ocean.io/v2/enrich/people',
    headers={'X-Api-Token': 'YOUR_API_TOKEN'},
    json={
        'peopleDataMapping': {
            'contact-001': {'person': {'linkedin': 'linkedin.com/in/jane-doe-123'}},
            'contact-002': {
                'person': {'firstName': 'John', 'lastName': 'Smith', 'jobTitle': 'CTO'},
                'company': {'domain': 'acme.com'},
            },
            'contact-003': {'person': {'id': 'ocean-person-id-abc'}},
        },
        'webhookUrl': 'https://yourapp.com/webhooks/ocean-people',
    },
)
data = response.json()  # {"status": "in progress"} — results arrive at your webhook

const response = await fetch('https://api.ocean.io/v2/enrich/people', {
  method: 'POST',
  headers: { 'X-Api-Token': 'YOUR_API_TOKEN', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    peopleDataMapping: {
      'contact-001': { person: { linkedin: 'linkedin.com/in/jane-doe-123' } },
      'contact-002': {
        person: { firstName: 'John', lastName: 'Smith', jobTitle: 'CTO' },
        company: { domain: 'acme.com' },
      },
      'contact-003': { person: { id: 'ocean-person-id-abc' } },
    },
    webhookUrl: 'https://yourapp.com/webhooks/ocean-people',
  }),
});
const data = await response.json(); // {"status": "in progress"} — results arrive at your webhook

Immediate response:

{ "status": "in progress" }

Webhook payload:

{
  "results": {
    "contact-001": {
      "status": "found",
      "person": { "id": "abc123", "name": "Jane Doe", "jobTitle": "Head of Product" }
    },
    "contact-002": { "status": "not_found", "person": null }
  }
}