Felo API PlatformFelo API Platform
Alle Endpoints von Apollo
v0.2.0-beta
OpenAPI 3.1.0

Massenanreicherung von Personen

Server:https://openapi.felo.ai
Client-Bibliotheken

Apollo

​

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

Massenanreicherung von Personen

​

Reichert die im details-Array des Anfrage-Bodys aufgeführten Personen an. Verwenden Sie die dokumentierten Detailfelder und Anreicherungsoptionen dieses Endpunkts; leiten Sie den Eingabevertrag des Einzelpersonen-Endpunkts nicht aus dieser Batch-Anfrage ab. Erfordert Felo-Administratorberechtigung.

Preisreferenz

  • Abrechnung: Abgerechnete Antworteinheiten.
  • Referenzschätzung pro Anfrage: USD 1.7775.
  • Kostenbasis pro Einheit: USD 0.0.
  • Ressourceneinheit: provider_credit.
  • Referenz-Kundenmultiplikator: 1.0. Nicht erneut auf einen abgerechneten Kundenbetrag anwenden.
  • Kostenbasen legen den endgültigen Kundenpreis nicht fest, auch nicht bei null.

Nur Referenzmetadaten, kein Kontenangebot, kein garantierter Preis und keine Ausgabenobergrenze. Ressourcen-Credits sind keine Felo-Credits. Endgültige Abrechnungen richten sich nach den Felo-Abrechnungsbelegen.

Query-Parameter
  • reveal_phone_number
    Typ: boolean
  • run_waterfall_email
    Typ: boolean
  • run_waterfall_phone
    Typ: boolean
  • webhook_url
    Typ: string
    min. Länge:  
    1
    max. Länge:  
    2048
    Format: https_url
Body
erforderlich
application/json
  • details
    Typ: array object[]
    erforderlich

    Geben Sie für jede Person, die angereichert werden soll, ein Objekt in diesem Array an. Bis zu 10 Personen.

    Eine anzureichernde Person. Geben Sie alle verfügbaren Identifikatoren an – je mehr, desto wahrscheinlicher die Übereinstimmung.

    • domain
      Typ: string

      Domain des Arbeitgebers der Person, ohne www. Beispiel: apollo.io

    • email
      Typ: string

      E-Mail-Adresse der Person.

    • first_name
      Typ: string

      Vorname, wird mit last_name verwendet. Beispiel: tim

    • hashed_email
      Typ: string

      MD5- oder SHA-256-Hash der E-Mail-Adresse.

    • id
      Typ: string

      Apollo-Personen-ID, z. B. aus einer Personensuche.

    • last_name
      Typ: string

      Nachname, wird mit first_name verwendet. Beispiel: zheng

    • linkedin_url
      Typ: string

      LinkedIn-Profil-URL der Person.

    • name
      Typ: string

      Vollständiger Name, z. B. "tim zheng"; ersetzt first_name + last_name.

    • organization_name
      Typ: string

      Name des Arbeitgebers der Person. Beispiel: apollo

Antworten
  • 200
    Typ: object

    Erfolgreiche Antwort

    • credits_consumed
      Typ: integer

      Antwortfeld

    • error_code
      Typ: string

      Antwortfeld

    • error_message
      Typ: string

      Antwortfeld

    • matches
      Typ: array string[]

      Antwort-Array

    • missing_records
      Typ: integer

      Antwortfeld

    • status
      Typ: string

      Antwortfeld

    • total_requested_enrichments
      Typ: integer

      Antwortfeld

    • unique_enriched_records
      Typ: integer

      Antwortfeld

    • waterfall
      Typ: object

      Antwortobjekt

    application/json
  • 400

    Die Anfrage konnte nicht verarbeitet werden. Prüfen Sie die Anfrageparameter.

  • 401

    Ein gültiger Felo-API-Schlüssel ist erforderlich.

  • 402

    Die Anfrage kann nicht fortgesetzt werden, da eine Abrechnungsvoraussetzung nicht erfüllt ist.

  • 403

    Das Konto ist für diesen Vorgang nicht berechtigt.

  • 429

    Ein Anfrage- oder Ausgabenlimit wurde erreicht.

  • 502

    Der Dienst konnte die Anfrage nicht abschließen.

  • 503

    Die API oder der Abrechnungsdienst ist vorübergehend nicht verfügbar.

  • 504

    Beim Verarbeiten der Anfrage ist eine Zeitüberschreitung aufgetreten.

  • default

    Fehlerantwort; Upstream-Passthrough-Antworten können Anbieterformate verwenden

    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