Companies
Enrichment
v1
Estimate Company Enrichment Job
Estimate the credit cost for enriching companies with AI-generated custom field values. Target the estimate with a specific list_id, flat company_ids, or a pre-computed company_count. Credit Note: This endpoint does not consume credits.
:::info Requires the companies:read OAuth2 scope. :::
post/v1/companies/enrichment-jobs/estimate
Query parameters
account_idstring required
The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.
Request body
Example request
{
"data": {
"attributes": {
"company_ids": [
"651713",
"467823"
],
"list_id": "12345",
"company_count": 1500,
"custom_field_id": "ai_account_score",
"enrichment_strategy": "missing_values"
}
}
}Response
Estimate calculated successfully
Example response
{
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"attributes": {
"estimated_total_credits": 100,
"company_count": 100
}
},
"meta": {
"request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
}
}