Felo API PlatformFelo API Platform
Todos os endpoints de Apollo
v0.2.0-beta
OpenAPI 3.1.0

Enriquecimento de pessoas em lote

Servidor:https://openapi.felo.ai
Bibliotecas Cliente

Apollo

​

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

Enriquecimento de pessoas em lote

​

Enriquece as pessoas listadas no array details do corpo da requisição. Use os campos de detalhe e os controles de enriquecimento documentados deste endpoint; não deduza o contrato de entrada do endpoint de pessoa única a partir desta requisição em lote. Requer permissão administrativa da Felo.

Pricing reference

  • Medição: unidades de resposta medidas.
  • Estimativa de referência por requisição: USD 1.7775.
  • Base de custo unitário: USD 0.0.
  • Unidade de recurso: provider_credit.
  • Multiplicador de referência do cliente: 1.0. Não o aplique novamente a um valor já liquidado do cliente.
  • As bases de custo não definem o preço final do cliente, inclusive quando forem zero.

Apenas metadados de referência, não uma cotação da conta, um preço garantido nem um limite de gastos. Créditos de recursos não são créditos Felo. As cobranças finais seguem os registros de cobrança da Felo.

Parâmetros de Consulta
  • reveal_phone_number
    Tipo: boolean
  • run_waterfall_email
    Tipo: boolean
  • run_waterfall_phone
    Tipo: boolean
  • webhook_url
    Tipo: string
    tamanho mínimo:  
    1
    tamanho máximo:  
    2048
    Formato: https_url
Corpo
obrigatório
application/json
  • details
    Tipo: array object[]
    obrigatório

    Forneça informações de cada pessoa que você deseja enriquecer como um objeto dentro deste array. Adicione até 10 pessoas.

    Uma pessoa a enriquecer. Informe todos os identificadores que tiver — quanto mais, maior a chance de correspondência.

    • domain
      Tipo: string

      Domínio do empregador da pessoa, sem www. Exemplo: apollo.io

    • email
      Tipo: string

      Endereço de e-mail da pessoa.

    • first_name
      Tipo: string

      Nome, usado com last_name. Exemplo: tim

    • hashed_email
      Tipo: string

      Hash MD5 ou SHA-256 do endereço de e-mail.

    • id
      Tipo: string

      ID de pessoa do Apollo, por exemplo, de uma pesquisa de pessoas.

    • last_name
      Tipo: string

      Sobrenome, usado com first_name. Exemplo: zheng

    • linkedin_url
      Tipo: string

      URL do perfil do LinkedIn da pessoa.

    • name
      Tipo: string

      Nome completo, por exemplo, "tim zheng"; substitui first_name + last_name.

    • organization_name
      Tipo: string

      Nome do empregador da pessoa. Exemplo: apollo

Respostas
  • 200
    Tipo: object

    Resposta bem-sucedida

    • credits_consumed
      Tipo: integer

      Campo de resposta

    • error_code
      Tipo: string

      Campo de resposta

    • error_message
      Tipo: string

      Campo de resposta

    • matches
      Tipo: array string[]

      Array de resposta

    • missing_records
      Tipo: integer

      Campo de resposta

    • status
      Tipo: string

      Campo de resposta

    • total_requested_enrichments
      Tipo: integer

      Campo de resposta

    • unique_enriched_records
      Tipo: integer

      Campo de resposta

    • waterfall
      Tipo: object

      Objeto de resposta

    application/json
  • 400

    Não foi possível processar a requisição. Verifique os parâmetros da requisição.

  • 401

    É necessária uma chave de API da Felo válida.

  • 402

    A requisição não pode prosseguir porque um requisito de cobrança não foi atendido.

  • 403

    A conta não tem permissão para realizar esta operação.

  • 429

    Um limite de requisições ou de gastos foi atingido.

  • 502

    O serviço não pôde concluir a requisição.

  • 503

    A API ou o serviço de cobrança está temporariamente indisponível.

  • 504

    O serviço atingiu o tempo limite ao processar a requisição.

  • default

    Resposta de erro; respostas repassadas do upstream podem usar formatos do provedor

    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