LEleadfeeder
Contacts
Enrichment
v1

Estimate Find Contact Data Job

Changed on

Estimate the credit cost for enriching contacts with email and phone data. Accepts either explicit contact_ids or a list_id to target an entire list. Returns the number of eligible contacts and the estimated total credits that would be consumed. Credit Note: This endpoint does not consume credits.

:::info Requires the contacts:read OAuth2 scope. :::

post/v1/contacts/find-contact-data-jobs/estimate

Request

  • Base URL
    https://api.leadfeeder.com
  • URL
    https://api.leadfeeder.com/v1/contacts/find-contact-data-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: contacts: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": {
      "contact_ids": [
        "1515122",
        "90571874"
      ],
      "enrichment_type": "full",
      "list_id": "contact_12345"
    }
  }
}

Response

Estimate calculated successfully

Example response

{
  "data": {
    "attributes": {
      "eligible_contacts": 2,
      "estimated_total_credits": 0.4
    },
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "meta": {
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}

Changes

  • 5d15ed543ab8Revision changes
    • breaking

      the // response's property type changed from integer to number for status

  • ac752c6c2be0Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status