Solicitação Enriquecimento

Esse endpoint é utilizado para solicitar o enriquecimento dos dados.

Além dos dados básicos para solicitar o enriquecimento, alguns layouts exigem um parâmetro extra, identificado como parameters, que serve para configurar detalhes específicos do processo.

Exemplo do Layout 3 (Padrão - Email Pf):

Parâmetro:
Nesse layout, o parâmetro parameters é utilizado para definir a quantidade de emails por pessoa que serão retornados.

Valor enviado:
Por exemplo, se você enviar ["2"], o sistema interpretará que deseja retornar 2 emails por pessoa.

Limite:
Existe um limite máximo de emails retornados por pessoa, sendo esse valor 5. Assim, mesmo que um valor acima de 5 seja enviado, o sistema considerará 5 como máximo.

Envio com múltiplos parâmetros:

Se o layout exigir mais de um parâmetro, estes devem ser enviados em um array, na ordem definida.

Exemplo: Se for necessário enviar dois parâmetros, eles devem ser enviados como ["1", "1"].

Em resumo, ao enviar a solicitação de enriquecimento:

Verifique se o layout selecionado possui o campo parameters.

Envie os valores dentro de um array JSON, respeitando a ordem e o limite máximo definido (no caso do layout de emails, o máximo é 5).

Body Params
integer
required
Defaults to 5

id do layout (os ids estão disponíveis na aba de 'Layouts de Enriquecimento')

string
required
Defaults to NDcxNzA3MDg4NzYKMzc5MzUxNDY4NDUKNDI1MTk3OTA4NzMK

O arquivo deve ser enviado em formato Base64

string
required
Defaults to csv

Formato do arquivo (csv ou txt)

string
required
Defaults to Teste Enriquecimento

Nome para seu enriquecimento

parameters
array of strings
Defaults to []

Apenas alguns layouts tem esse parametro. Ex: layout 3 (Padrao - Email Pf) parameters : ["2"].

parameters
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json