Felo API PlatformFelo API Platform
Alle endpoints van Apollo
v0.2.0-beta
OpenAPI 3.1.0

Bulkverrijking van personen

Server:https://openapi.felo.ai
Clientbibliotheken

Apollo

​

Person and company enrichment, people search, company job postings and news. Requires Felo administrative permission.

Bulkverrijking van personen

​

Verrijkt de personen die in het details-array van de verzoekbody staan. Gebruik de gedocumenteerde detailvelden en verrijkingsinstellingen van dit endpoint; leid het invoercontract van het endpoint voor één persoon niet af uit dit batchverzoek. Vereist Felo-beheerdersrechten.

Prijsreferentie

  • Metering: Gemeten responseenheden.
  • Referentieschatting per verzoek: USD 1.7775.
  • Kostenbasis per eenheid: USD 0.0.
  • Resource-eenheid: provider_credit.
  • Referentieklantvermenigvuldiger: 1.0. Pas deze niet opnieuw toe op een afgerekend klantbedrag.
  • Kostenbases bepalen niet de uiteindelijke klantprijs, ook niet wanneer die nul is.

Alleen referentiemetadata, geen accountofferte, geen gegarandeerde prijs en geen bestedingslimiet. Resourcecredits zijn geen Felo-tegoed. De uiteindelijke kosten volgen de factureringsgegevens van Felo.

Queryparameters
  • reveal_phone_number
    Type: boolean
  • run_waterfall_email
    Type: boolean
  • run_waterfall_phone
    Type: boolean
  • webhook_url
    Type: string
    min. lengte:  
    1
    max. lengte:  
    2048
    Formaat: https_url
Body
verplicht
application/json
  • details
    Type: array object[]
    verplicht

    Geef voor elke persoon die je wilt verrijken een object binnen deze array op. Maximaal 10 personen.

    Eén persoon om te verrijken. Geef alle identificaties die je hebt — hoe meer, hoe groter de kans op een match.

    • domain
      Type: string

      Domein van de werkgever van de persoon, zonder www. Voorbeeld: apollo.io

    • email
      Type: string

      E-mailadres van de persoon.

    • first_name
      Type: string

      Voornaam, gebruikt met last_name. Voorbeeld: tim

    • hashed_email
      Type: string

      MD5- of SHA-256-hash van het e-mailadres.

    • id
      Type: string

      Apollo-persoon-id, bijvoorbeeld uit een personenzoekopdracht.

    • last_name
      Type: string

      Achternaam, gebruikt met first_name. Voorbeeld: zheng

    • linkedin_url
      Type: string

      LinkedIn-profiel-URL van de persoon.

    • name
      Type: string

      Volledige naam, bijvoorbeeld "tim zheng"; vervangt first_name + last_name.

    • organization_name
      Type: string

      Naam van de werkgever van de persoon. Voorbeeld: apollo

Responsen
  • 200
    Type: object

    Geslaagde respons

    • credits_consumed
      Type: integer

      Responsveld

    • error_code
      Type: string

      Responsveld

    • error_message
      Type: string

      Responsveld

    • matches
      Type: array string[]

      Responsarray

    • missing_records
      Type: integer

      Responsveld

    • status
      Type: string

      Responsveld

    • total_requested_enrichments
      Type: integer

      Responsveld

    • unique_enriched_records
      Type: integer

      Responsveld

    • waterfall
      Type: object

      Responsobject

    application/json
  • 400

    Het verzoek kon niet worden verwerkt. Controleer de verzoekparameters.

  • 401

    Een geldige Felo-API-sleutel is vereist.

  • 402

    Het verzoek kan niet doorgaan omdat niet aan een factureringsvoorwaarde is voldaan.

  • 403

    Het account mag deze bewerking niet uitvoeren.

  • 429

    Een verzoek- of bestedingslimiet is bereikt.

  • 502

    De dienst kon het verzoek niet voltooien.

  • 503

    De API of factureringsdienst is tijdelijk niet beschikbaar.

  • 504

    Er is een time-out opgetreden bij het verwerken van het verzoek.

  • default

    Foutrespons; upstream-passthrough-responsen kunnen indelingen van de provider gebruiken

    application/json
Request Example for post/v1/beta/apollo/people/bulk_match
curl https://openapi.felo.ai/v1/beta/apollo/people/bulk_match \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "details": [
    {
      "first_name": "",
      "last_name": "",
      "name": "",
      "email": "",
      "hashed_email": "",
      "organization_name": "",
      "domain": "",
      "id": "",
      "linkedin_url": ""
    }
  ]
}'
{
  "status": "string",
  "error_code": "string",
  "error_message": "string",
  "total_requested_enrichments": 1,
  "unique_enriched_records": 1,
  "missing_records": 1,
  "credits_consumed": 1,
  "matches": [
    "string"
  ],
  "waterfall": {}
}
Bulk People Enrichment