LEleadfeeder
Companies
Enrichment
v1

Estimate Company Enrichment Job

Changed on

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

Request

  • Base URL
    https://api.leadfeeder.com
  • URL
    https://api.leadfeeder.com/v1/companies/enrichment-jobs/estimate
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.leadfeeder.com/v1/oauth/authorize
      Token URL: https://api.leadfeeder.com/v1/oauth/token scopes: companies:read

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_count": 1500,
      "company_ids": [
        "651713",
        "467823"
      ],
      "contact_collection": {
        "contacts_to_enrich": 10
      },
      "custom_field_id": "ai_account_score",
      "enrichment_strategy": "missing_values",
      "limit": 100,
      "list_id": "company_12345",
      "prompt": "Find contacts in top management working in procurement."
    }
  }
}

Response

Estimate calculated successfully

Example response

{
  "data": {
    "attributes": {
      "company_count": 42,
      "estimated_total_credits": 0.42
    },
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "meta": {
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}

Changes