Iniciar uma importação de leads

Começa a importação com o mapeamento da última simulação concluída (409 lead_import_not_ready antes dela). As permissões são conferidas de novo aqui e no servidor que executa, antes de gravar qualquer linha (403 lead_import_forbidden; uma importação com a coluna de consentimento sem leads:consent dá 403 lead_consent_grant_forbidden). A importação roda em lotes de 500 linhas, cada lote numa transação, e continua do último lote gravado se o servidor reiniciar ou se um erro passageiro (banco fora do ar, tempo esgotado) interromper; depois de 3 tentativas ela para com failureCode stalled. Permissão retirada, arquivo apagado ou mapeamento que deixou de servir param na hora (forbidden, file_unavailable, internal); uma importação da rota antiga interrompida no meio para com interrupted. Leads novos entram com origem import; leads existentes só ganham o que estava vazio (o nome que veio do canal, como o perfil do WhatsApp, é trocado pelo da planilha; um nome dado pela equipe ou por outra importação nunca), e cada mudança aumenta a version do lead (a importação é a exceção documentada ao If-Match, porque nunca troca um valor existente). Telefones novos entram como contato; um endereço entra como principal quando o lead não tem nenhum, com posição exata quando a linha traz latitude e longitude válidas dentro do Brasil, e pendente para o mapa nos outros casos; quando o lead já tem endereço, só as partes vazias do principal são completadas (uma parte diferente vira conflito e nada muda) e um pino manual nunca é trocado. Telefones compartilhados por mais de 5.000 leads não servem para achar a pessoa: a linha sem WhatsApp é recusada com contact_ambiguous. Um vínculo de família que já existe entre os dois é informado com relation_exists. Um lead criado sem um campo personalizado obrigatório que você vê é informado com custom_field_required. Os vínculos de família são resolvidos depois das linhas: relative_number é o WhatsApp de um lead do arquivo ou da base e relation_kind é o que a pessoa da linha é desse familiar (por exemplo filha). Acompanhe por GET /leads/imports/{id}.
Os e-mails são verificados de graça durante a simulação e a importação, uma busca de DNS por domínio distinto: dryRun.emails e result.emails contam cada veredito (valid, typo, disposable, no_mail_domain, bad_address, suppressed, domain_unknown, domain_pending, role, inactive) e cada problema entra em issues com o código email_*. O corpo é opcional: fixEmailTypos troca um domínio com provável erro de digitação pela sugestão (por exemplo gmial.com por gmail.com) e dropUndeliverableEmails importa o lead sem o e-mail quando ele é temporário, quando o domínio não recebe mensagens ou quando o endereço já voltou como inexistente. Sem corpo, os e-mails entram como vieram. As escolhas voltam em emailFixes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID da importação

Body Params

Correções de e-mail

boolean
boolean
Headers
string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

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