Funis de marketing

analyze_marketing_funnel

Leitura

Números de um funil de captação: volume por etapa e status, conversão, valor, leads parados e os de maior prioridade.

Permissão

marketing-funnels:read

Operação

funnels.insights

Módulo

campaigns

Parâmetros

funnelIdstringobrigatório

bulk_add_funnel_leads

Escrita

Põe em lote num funil de captação os contatos com certas tags, de um segmento ou de uma lista (até 5.000). Quem já está no funil fica onde está. Com startCadence, a cadência da etapa começa com os envios de WhatsApp espaçados. Devolve o batchId para desfazer.

Permissão

marketing-funnels:write

Operação

funnels.leads.bulk_add

Módulo

campaigns

Parâmetros

funnelIdstringobrigatório

tagIdsstring[]opcional

Contatos com estas tags.

tagMatchstringopcional

any = tem qualquer uma das tags; all = tem todas.anyall

excludeTagIdsstring[]opcional

Deixa de fora quem tem estas.

segmentIdstringopcional

Contatos de um segmento salvo.

contactIdsstring[]opcional

stageIdstringopcional

Etapa de entrada. Sem ela, a inicial.

startCadencebooleanopcional

Inicia a cadência da etapa. false = só organiza no funil.

create_funnel_lead

Escrita

Põe um contato num funil de captação (na etapa inicial ou na informada). Se o contato já está no funil, devolve o lead existente.

Permissão

marketing-funnels:write

Operação

funnels.leads.create

Módulo

campaigns

Parâmetros

funnelIdstringobrigatório

contactIdstringobrigatório

stageIdstringopcional

campaignIdstringopcional

estimatedValuenumberopcional

create_funnel_rule

Escrita

Cria uma regra: quando o gatilho acontece (resposta, e-mail aberto, agendamento, etiqueta, formulário, inatividade, intenção de compra) e as condições batem, o lead vai para a etapa de destino e as ações rodam.

Permissão

marketing-funnels:write

Operação

funnels.rules.create

Módulo

campaigns

Parâmetros

funnelIdstringobrigatório

namestringobrigatório

triggerstringobrigatório

MESSAGE_RECEIVEDEMAIL_OPENEDEMAIL_CLICKEDAPPOINTMENT_BOOKEDTAG_ADDEDFORM_SUBMITTEDNO_ACTIVITYPURCHASE_INTENTMANUAL

toStageIdstringobrigatório

fromStageIdstringopcional

Só leads nesta etapa. Nulo = qualquer.

conditionsobject[]opcional

conditions[].fieldstringobrigatório

messageBodychanneltagNameemailTypeidleDays

conditions[].operatorstringobrigatório

existsequalsnot_equalscontainsgtelte

conditions[].valueanyopcional

actionsobject[]opcional

actions[].typestringobrigatório

add_tagsend_webhookmark_lostnotify

actions[].paramsobjectopcional

orderintegeropcional

create_marketing_funnel

Escrita

Cria um funil de captação com as etapas.

Permissão

marketing-funnels:write

Operação

funnels.create

Módulo

campaigns

Parâmetros

namestringobrigatório

descriptionstringopcional

stagesobject[]opcional

stages[].idstringopcional

Etapa existente (ao editar). Sem id = etapa nova.

stages[].namestringobrigatório

stages[].orderintegerobrigatório

stages[].colorstringopcional

stages[].isInitialbooleanopcional

Onde o lead entra.

stages[].isGoalbooleanopcional

Chegar aqui ganha o lead.

staleDaysintegeropcional

Lead parado este número de dias é perdido sozinho. Nulo desliga.

autoCreateDealbooleanopcional

Ganhar o lead cria um negócio em vendas.

dealStageIdstringopcional

Etapa de vendas onde o negócio nasce.

delete_funnel_lead

Escrita

Tira um lead do funil. Exige o id exato.

Permissão

marketing-funnels:write

Operação

funnels.leads.delete

Módulo

campaigns

Parâmetros

cardIdstringobrigatório

delete_funnel_rule

Escrita

Apaga uma regra de transição.

Permissão

marketing-funnels:write

Operação

funnels.rules.delete

Módulo

campaigns

Parâmetros

ruleIdstringobrigatório

delete_marketing_funnel

Escrita

Apaga um funil de captação e todos os leads dele. Exige o id exato.

Permissão

marketing-funnels:write

Operação

funnels.delete

Módulo

campaigns

Parâmetros

funnelIdstringobrigatório

delete_stage_cadence

Escrita

Apaga a cadência de follow-up de uma etapa.

Permissão

marketing-funnels:write

Operação

funnels.cadence.delete

Módulo

campaigns

Parâmetros

stageIdstringobrigatório

get_funnel_lead_timeline

Leitura

Histórico de um lead no funil: mudanças de etapa e sinais (respostas, cliques…).

Permissão

marketing-funnels:read

Operação

funnels.leads.timeline

Módulo

campaigns

Parâmetros

cardIdstringobrigatório

get_marketing_funnel

Leitura

Um funil de captação com etapas e regras de transição.

Permissão

marketing-funnels:read

Operação

funnels.get

Módulo

campaigns

Parâmetros

funnelIdstringobrigatório

get_stage_cadence

Leitura

A cadência de follow-up de uma etapa do funil (passos, canais e esperas).

Permissão

marketing-funnels:read

Operação

funnels.cadence.get

Módulo

campaigns

Parâmetros

stageIdstringobrigatório

list_funnel_leads

Leitura

Leads de um funil de captação, paginados, por etapa, status, pontuação mínima, campanha ou dias sem atividade.

Permissão

marketing-funnels:read

Operação

funnels.leads.list

Módulo

campaigns

Parâmetros

funnelIdstringobrigatório

stageIdstringopcional

statusstringopcional

ACTIVEWONLOSTSTALLED

minLeadScoreintegeropcional

campaignIdstringopcional

inactiveDaysintegeropcional

pageintegeropcional

limitintegeropcional

list_funnel_rules

Leitura

Regras de transição de um funil: o que move um lead de etapa sozinho.

Permissão

marketing-funnels:read

Operação

funnels.rules.list

Módulo

campaigns

Parâmetros

funnelIdstringobrigatório

list_marketing_funnels

Leitura

Funis de captação (onde o lead anda antes de virar negócio) com as etapas. Não é o funil de vendas.

Permissão

marketing-funnels:read

Operação

funnels.list

Módulo

campaigns

Parâmetros

Sem parâmetros.

move_funnel_lead

Escrita

Move um lead para outra etapa do funil. Chegar à etapa de objetivo ganha o lead e pode criar o negócio configurado.

Permissão

marketing-funnels:write

Operação

funnels.leads.move

Módulo

campaigns

Parâmetros

cardIdstringobrigatório

stageIdstringobrigatório

positionintegeropcional

preview_funnel_leads_bulk_add

Leitura

Prévia da adição em lote num funil de captação: quantos contatos batem com as tags, segmento ou lista, quantos já estão no funil, quantos ficam sem WhatsApp ou e-mail e a cadência da etapa de entrada.

Permissão

marketing-funnels:read

Operação

funnels.leads.bulk_preview

Módulo

campaigns

Parâmetros

funnelIdstringobrigatório

tagIdsstring[]opcional

Contatos com estas tags.

tagMatchstringopcional

any = tem qualquer uma das tags; all = tem todas.anyall

excludeTagIdsstring[]opcional

Deixa de fora quem tem estas.

segmentIdstringopcional

Contatos de um segmento salvo.

contactIdsstring[]opcional

stageIdstringopcional

Etapa de entrada. Sem ela, a inicial.

undo_funnel_leads_bulk_add

Escrita

Desfaz uma adição em lote: tira do funil os leads do lote em que nada aconteceu ainda (sem mensagem da cadência nem mudança de etapa).

Permissão

marketing-funnels:write

Operação

funnels.leads.bulk_undo

Módulo

campaigns

Parâmetros

funnelIdstringobrigatório

batchIdstring (uuid)obrigatório

update_funnel_lead

Escrita

Marca um lead como ativo, ganho ou perdido (com motivo) ou muda o valor estimado. Ganhar pode criar o negócio configurado no funil.

Permissão

marketing-funnels:write

Operação

funnels.leads.update

Módulo

campaigns

Parâmetros

cardIdstringobrigatório

statusstringopcional

ACTIVEWONLOST

lostReasonstringopcional

estimatedValuenumberopcional

update_funnel_rule

Escrita

Altera uma regra de transição (inclusive ligar ou desligar).

Permissão

marketing-funnels:write

Operação

funnels.rules.update

Módulo

campaigns

Parâmetros

ruleIdstringobrigatório

namestringopcional

triggerstringopcional

MESSAGE_RECEIVEDEMAIL_OPENEDEMAIL_CLICKEDAPPOINTMENT_BOOKEDTAG_ADDEDFORM_SUBMITTEDNO_ACTIVITYPURCHASE_INTENTMANUAL

toStageIdstringopcional

isActivebooleanopcional

fromStageIdstringopcional

Só leads nesta etapa. Nulo = qualquer.

conditionsobject[]opcional

conditions[].fieldstringobrigatório

messageBodychanneltagNameemailTypeidleDays

conditions[].operatorstringobrigatório

existsequalsnot_equalscontainsgtelte

conditions[].valueanyopcional

actionsobject[]opcional

actions[].typestringobrigatório

add_tagsend_webhookmark_lostnotify

actions[].paramsobjectopcional

orderintegeropcional

update_marketing_funnel

Escrita

Altera um funil de captação. `stages` substitui o conjunto inteiro de etapas (cria, altera e remove para ficar igual).

Permissão

marketing-funnels:write

Operação

funnels.update

Módulo

campaigns

Parâmetros

funnelIdstringobrigatório

namestringopcional

isActivebooleanopcional

descriptionstringopcional

stagesobject[]opcional

stages[].idstringopcional

Etapa existente (ao editar). Sem id = etapa nova.

stages[].namestringobrigatório

stages[].orderintegerobrigatório

stages[].colorstringopcional

stages[].isInitialbooleanopcional

Onde o lead entra.

stages[].isGoalbooleanopcional

Chegar aqui ganha o lead.

staleDaysintegeropcional

Lead parado este número de dias é perdido sozinho. Nulo desliga.

autoCreateDealbooleanopcional

Ganhar o lead cria um negócio em vendas.

dealStageIdstringopcional

Etapa de vendas onde o negócio nasce.

upsert_stage_cadence

Escrita

Cria ou substitui a cadência de follow-up de uma etapa: mensagens por e-mail ou WhatsApp com espera entre elas, e o que fazer quando acabam.

Permissão

marketing-funnels:write

Operação

funnels.cadence.upsert

Módulo

campaigns

Parâmetros

stageIdstringobrigatório

isActivebooleanopcional

onExhauststringobrigatório

Ao terminar: nada, perder o lead ou mover.NONEMARK_LOSTMOVE_STAGE

onExhaustStageIdstringopcional

Etapa de destino (MOVE_STAGE).

stepsobject[]obrigatório

steps[].idstringopcional

steps[].orderintegeropcional

Padrão: a posição na lista.

steps[].delayMinutesintegerobrigatório

Espera desde o passo anterior (ou da entrada na etapa).

steps[].channelstringobrigatório

EMAILWHATSAPP

steps[].subjectstringopcional

steps[].bodystringobrigatório

Texto. Vazio quando o passo usa templateId.

steps[].templateIdstringopcional

Modelo aprovado (WhatsApp) no lugar do texto.

steps[].isBreakupbooleanopcional

Última tentativa ("vou parar de escrever").