Create a new list with data and immediately start an enrichment job. This is a convenient way to import and enrich data in a single API call.
Maximum 250 records can be processed in a single request.
Body Parameters
Name of the list to create
Optional webhook URL to receive notifications about enrichment progress
Enrichment configuration object
Type of enrichment to perform. Must be one of:
email - Enrich and verify email addressesphone - Enrich and verify phone numbersboth - Enrich both email and phone
Whether to verify discovered email addresses
Whether to verify discovered phone numbers
Whether to attempt completing missing contact data
Array of objects containing contact data. Maximum 250 records per request.
Object defining how input data maps to contact fields
Field containing first name
Field containing last name
Field containing website/domain
Field containing company name
Field containing contact’s LinkedIn URL
Field containing company’s LinkedIn URL
Field containing job title
Response
Success message confirming list creation and enrichment queued
ID of the created enrichment job
curl --request POST \
--url https://api.pipeium.com/lists/bulk-enrich \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data '{
"name": "Sales Prospects Q4",
"webhook_url": "https://your-domain.com/webhook",
"enrichment": {
"type": "both",
"verify_email": true,
"complete_missing_data": true
},
"data": [
{
"name": "John Smith",
"company": "Acme Inc",
"website": "acme.com",
"title": "Sales Director"
}
],
"mappings": {
"first_name": "name",
"company_name": "company",
"website": "website",
"job_title": "title"
}
}'
{
"message": "List created and enrichment queued",
"list_id": "550e8400-e29b-41d4-a716-446655440000",
"enrichment_id": "123e4567-e89b-12d3-a456-426614174000"
}
