POST
/
v1
/
enrichments
curl -X POST https://api.pipeium.com/v1/enrichments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "list_id": "list_123",
    "enrichment_type": "both",
    "verify_email": true,
    "complete_missing_data": true
  }'
{
  "message": "Queued for enrichment",
  "enrichmentId": "enr_123"
}

Request Body

list_id
string
required

The ID of the list to enrich

enrichment_type
string
required

Type of enrichment to perform. Must be one of:

  • email - Enrich with email addresses only
  • phone - Enrich with phone numbers only
  • both - Enrich with both email and phone numbers
verify_email
boolean

Whether to verify discovered email addresses. Defaults to false.

complete_missing_data
boolean

Whether to fill in missing fields like company, title, and location. Defaults to false.

Response

message
string

Success message confirming the enrichment job was queued

enrichmentId
string

The ID of the created enrichment job. Use this to check the status.

curl -X POST https://api.pipeium.com/v1/enrichments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "list_id": "list_123",
    "enrichment_type": "both",
    "verify_email": true,
    "complete_missing_data": true
  }'
{
  "message": "Queued for enrichment",
  "enrichmentId": "enr_123"
}