Recursos
Leads
O lead é a pessoa ou empresa cliente, com telefones, endereços, campos personalizados, consentimento e histórico, ligada às conversas dela em todos os canais. Este grupo cadastra, edita, busca e lista leads; importa planilhas; executa ações em massa sobre uma seleção (classificar, atribuir responsável, bloquear, exportar, criar público da Meta, montar lista de ligação ou preparar um disparo); mostra o mapa e as áreas desenhadas; e gerencia empresas de leads e relações entre leads. Ações em massa exigem o cabeçalho Idempotency-Key e a contagem confirmada na prévia. Para os conceitos e exemplos, leia Filtros de leads e conversas.
Rotas 67
- GETConversa por entrada
/entries/{entryId}/conversation - GETFicha do lead de uma conversa
/entries/{entryId}/lead - GETListar áreas desenhadas
/lead-areas - GETVer área desenhada
/lead-areas/{id} - GETLeads por bairro
/leads/map/districts - GETAproximados que ficaram fora das áreas
/leads/map/left-out - GETLeads de um ponto do mapa
/leads/map/point - GETPonto de referência de um CEP ou endereço
/leads/map/reference-point - GETContorno de uma região do mapa
/leads/map/region - GETRegiões do mapa
/leads/map/regions - GETResumo do mapa de leads
/leads/map/summary - GETTile do mapa de leads
/leads/map/tiles/{z}/{x}/{y} - GETEnquadramento inicial do mapa
/leads/map/viewport - GETBuscar lugares para o mapa
/leads/places/search - GETSugerir cidade, bairro, rua ou CEP de um endereço
/leads/places/suggest - GETFacetas da página de leads
/leads/sections/facets - GETLugares da página de leads
/leads/sections/places - GETResumo da página de leads
/leads/sections/summary - GETAnálises do lead por campanha
/leads/{id}/campaigns/{campaignId}/analysis - GETEntradas do lead por campanha
/leads/{id}/campaigns/{campaignId}/entries - GETResumo do lead para as abas e os telefones
/leads/{id}/summary - GETListar empresas de leads
/v1/lead-companies - GETVer empresa de leads
/v1/lead-companies/{id} - GETListar leads
/v1/leads - GETAndamento de um público da Meta criado a partir de leads
/v1/leads/actions/audiences/{audienceId} - GETAndamento de uma prévia de ação sobre leads
/v1/leads/actions/previews/{previewId} - GETAndamento de uma ação em massa sobre leads
/v1/leads/actions/{runId} - GETListar as suas importações de leads
/v1/leads/imports - GETLimites da importação de leads
/v1/leads/imports/limits - GETVer uma importação de leads
/v1/leads/imports/{id} - GETBaixar as linhas recusadas de uma importação
/v1/leads/imports/{id}/rejections - GETBuscar lead por número
/v1/leads/search - GETObter lead por ID
/v1/leads/{id} - GETHistórico de campanhas do lead
/v1/leads/{id}/campaigns - GETNegociações do lead
/v1/leads/{id}/deals - GETFamília e indicações do lead
/v1/leads/{id}/relatives - GETLinha do tempo do lead
/v1/leads/{id}/timeline - POSTCriar área desenhada
/lead-areas - POSTCadastrar empresa de leads
/v1/lead-companies - POSTCadastrar um lead
/v1/leads - POSTExecutar uma ação em massa sobre leads
/v1/leads/actions - POSTPrévia de uma ação em massa sobre leads
/v1/leads/actions/preview - POSTCancelar um envio preparado a partir de leads
/v1/leads/actions/sends/cancel - POSTRevisar um envio preparado a partir de leads
/v1/leads/actions/sends/review - POSTEnviar um envio preparado a partir de leads
/v1/leads/actions/sends/start - POSTEnviar uma planilha de leads
/v1/leads/imports - POSTSimular uma importação de leads
/v1/leads/imports/{id}/dry-run - POSTIniciar uma importação de leads
/v1/leads/imports/{id}/start - POSTCadastrar ou atualizar um lead
/v1/leads/upsert - POSTPôr o alfinete do endereço à mão
/v1/leads/{id}/addresses/{addressId}/pin - POSTAnonimizar um lead
/v1/leads/{id}/anonymize - POSTBloquear ou desbloquear lead
/v1/leads/{id}/block - POSTDefinir a empresa do lead
/v1/leads/{id}/company - POSTRegistrar ou retirar o consentimento do lead
/v1/leads/{id}/consent - POSTDefinir o bairro e a cidade do lead
/v1/leads/{id}/district - POSTUsar a localização que o lead mandou
/v1/leads/{id}/location-candidates/{messageId}/accept - POSTRegistrar que o lead não quer receber mensagens
/v1/leads/{id}/opt-out - POSTDefinir o responsável pelo lead
/v1/leads/{id}/owner - POSTLigar dois leads
/v1/leads/{id}/relations - POSTCadastrar um familiar do lead
/v1/leads/{id}/relatives - PUTEditar um lead
/v1/leads/{id} - PATCHAlterar área desenhada
/lead-areas/{id} - PATCHAlterar empresa de leads
/v1/lead-companies/{id} - PATCHRenomear um lead
/v1/leads/{id} - DELETEApagar área desenhada
/lead-areas/{id} - DELETEExcluir empresa de leads
/v1/lead-companies/{id} - DELETEDesfazer uma relação entre leads
/v1/lead-relations/{id}