Enviar uma planilha de leads

Primeiro passo da importação: recebe a planilha (multipart com o campo file, CSV ou TSV de até 20 MB e 200.000 linhas) ou o mediaId de um arquivo que já está na biblioteca (JSON {mediaId}, o caminho do Elo e das campanhas; exige também media:read, e só arquivos que aparecem na biblioteca servem, nunca a planilha guardada de outra importação). O arquivo vai para o armazenamento de mídias sem aparecer na biblioteca e é apagado com a importação após 7 dias. A resposta traz as colunas lidas, até 5 linhas de amostra, a sugestão de destino de cada coluna (preview.columns[].field, vazio quando nenhuma serve) e o catálogo de campos (fields): número de WhatsApp, até quatro telefones de contato (phone:mobile, phone:landline, phone:work, phone:message, phone:other), nome, apelido, e-mail, nascimento, CEP, logradouro, número, complemento, bairro, cidade, UF, latitude e longitude, responsável por e-mail, data e finalidade do consentimento (exigem leads:consent), cada campo personalizado de lead (custom_field:<chave>) e o vínculo familiar (relative_number com relation_kind). Cada campo diz se você pode mapeá-lo (allowed) e qual permissão exige (requires); options diz se você pode completar leads existentes (fillEmpty, exige leads:update) e abrir conversas (seedInbox, seedConversations). Só quem enviou vê a importação. Cada pessoa guarda no máximo 5 envios ainda não importados (enviados, simulados ou que falharam antes de começar); um envio novo apaga o mais antigo deles, com o arquivo. O envio passa pelo mesmo limite de frequência dos uploads de mídia (429). Códigos: 400 lead_import_empty, lead_import_unsupported_file; 403 lead_import_forbidden com details.permission (media:read); 404 lead_import_file_unavailable; 413 lead_import_file_too_large, lead_import_too_many_rows.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
file

Planilha CSV ou TSV

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