POST
/
enrichments
curl --request POST \
  --url https://api.pipeium.com/enrichments \
  --header 'Authorization: Bearer {api_key}' \
  --header 'Content-Type: application/json' \
  --data '{
    "list_id": "550e8400-e29b-41d4-a716-446655440000",
    "enrichment_type": "both",
    "verify_email": true,
    "complete_missing_data": true
  }'
{
  "message": "Queued for enrichment",
  "enrichmentId": "123e4567-e89b-12d3-a456-426614174000"
}
Create a new enrichment job to enrich contact data in a list. This can include email verification, phone verification, or both.

Body Parameters

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 and verify email addresses
  • phone - Enrich and verify phone numbers
  • both - Enrich both email and phone
verify_email
boolean
Whether to verify discovered email addresses. Defaults to true.
complete_missing_data
boolean
Whether to attempt completing missing contact data. Defaults to true.

Response

message
string
Success message confirming enrichment was queued
enrichmentId
string
ID of the created enrichment job
curl --request POST \
  --url https://api.pipeium.com/enrichments \
  --header 'Authorization: Bearer {api_key}' \
  --header 'Content-Type: application/json' \
  --data '{
    "list_id": "550e8400-e29b-41d4-a716-446655440000",
    "enrichment_type": "both",
    "verify_email": true,
    "complete_missing_data": true
  }'
{
  "message": "Queued for enrichment",
  "enrichmentId": "123e4567-e89b-12d3-a456-426614174000"
}