Marketing funnels

analyze_marketing_funnel

Read

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

Permission

marketing-funnels:read

Operation

funnels.insights

Module

campaigns

Parameters

funnelIdstringrequired

bulk_add_funnel_leads

Write

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.

Permission

marketing-funnels:write

Operation

funnels.leads.bulk_add

Module

campaigns

Parameters

funnelIdstringrequired

tagIdsstring[]optional

Contatos com estas tags.

tagMatchstringoptional

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

excludeTagIdsstring[]optional

Deixa de fora quem tem estas.

segmentIdstringoptional

Contatos de um segmento salvo.

contactIdsstring[]optional

stageIdstringoptional

Etapa de entrada. Sem ela, a inicial.

startCadencebooleanoptional

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

create_funnel_lead

Write

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.

Permission

marketing-funnels:write

Operation

funnels.leads.create

Module

campaigns

Parameters

funnelIdstringrequired

contactIdstringrequired

stageIdstringoptional

campaignIdstringoptional

estimatedValuenumberoptional

create_funnel_rule

Write

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.

Permission

marketing-funnels:write

Operation

funnels.rules.create

Module

campaigns

Parameters

funnelIdstringrequired

namestringrequired

triggerstringrequired

MESSAGE_RECEIVEDEMAIL_OPENEDEMAIL_CLICKEDAPPOINTMENT_BOOKEDTAG_ADDEDFORM_SUBMITTEDNO_ACTIVITYPURCHASE_INTENTMANUAL

toStageIdstringrequired

fromStageIdstringoptional

Só leads nesta etapa. Nulo = qualquer.

conditionsobject[]optional

conditions[].fieldstringrequired

messageBodychanneltagNameemailTypeidleDays

conditions[].operatorstringrequired

existsequalsnot_equalscontainsgtelte

conditions[].valueanyoptional

actionsobject[]optional

actions[].typestringrequired

add_tagsend_webhookmark_lostnotify

actions[].paramsobjectoptional

orderintegeroptional

create_marketing_funnel

Write

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

Permission

marketing-funnels:write

Operation

funnels.create

Module

campaigns

Parameters

namestringrequired

descriptionstringoptional

stagesobject[]optional

stages[].idstringoptional

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

stages[].namestringrequired

stages[].orderintegerrequired

stages[].colorstringoptional

stages[].isInitialbooleanoptional

Onde o lead entra.

stages[].isGoalbooleanoptional

Chegar aqui ganha o lead.

staleDaysintegeroptional

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

autoCreateDealbooleanoptional

Ganhar o lead cria um negócio em vendas.

dealStageIdstringoptional

Etapa de vendas onde o negócio nasce.

delete_funnel_lead

Write

Tira um lead do funil. Exige o id exato.

Permission

marketing-funnels:write

Operation

funnels.leads.delete

Module

campaigns

Parameters

cardIdstringrequired

delete_funnel_rule

Write

Apaga uma regra de transição.

Permission

marketing-funnels:write

Operation

funnels.rules.delete

Module

campaigns

Parameters

ruleIdstringrequired

delete_marketing_funnel

Write

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

Permission

marketing-funnels:write

Operation

funnels.delete

Module

campaigns

Parameters

funnelIdstringrequired

delete_stage_cadence

Write

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

Permission

marketing-funnels:write

Operation

funnels.cadence.delete

Module

campaigns

Parameters

stageIdstringrequired

get_funnel_lead_timeline

Read

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

Permission

marketing-funnels:read

Operation

funnels.leads.timeline

Module

campaigns

Parameters

cardIdstringrequired

get_marketing_funnel

Read

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

Permission

marketing-funnels:read

Operation

funnels.get

Module

campaigns

Parameters

funnelIdstringrequired

get_stage_cadence

Read

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

Permission

marketing-funnels:read

Operation

funnels.cadence.get

Module

campaigns

Parameters

stageIdstringrequired

list_funnel_leads

Read

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

Permission

marketing-funnels:read

Operation

funnels.leads.list

Module

campaigns

Parameters

funnelIdstringrequired

stageIdstringoptional

statusstringoptional

ACTIVEWONLOSTSTALLED

minLeadScoreintegeroptional

campaignIdstringoptional

inactiveDaysintegeroptional

pageintegeroptional

limitintegeroptional

list_funnel_rules

Read

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

Permission

marketing-funnels:read

Operation

funnels.rules.list

Module

campaigns

Parameters

funnelIdstringrequired

list_marketing_funnels

Read

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

Permission

marketing-funnels:read

Operation

funnels.list

Module

campaigns

Parameters

No parameters.

move_funnel_lead

Write

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

Permission

marketing-funnels:write

Operation

funnels.leads.move

Module

campaigns

Parameters

cardIdstringrequired

stageIdstringrequired

positionintegeroptional

preview_funnel_leads_bulk_add

Read

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.

Permission

marketing-funnels:read

Operation

funnels.leads.bulk_preview

Module

campaigns

Parameters

funnelIdstringrequired

tagIdsstring[]optional

Contatos com estas tags.

tagMatchstringoptional

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

excludeTagIdsstring[]optional

Deixa de fora quem tem estas.

segmentIdstringoptional

Contatos de um segmento salvo.

contactIdsstring[]optional

stageIdstringoptional

Etapa de entrada. Sem ela, a inicial.

undo_funnel_leads_bulk_add

Write

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).

Permission

marketing-funnels:write

Operation

funnels.leads.bulk_undo

Module

campaigns

Parameters

funnelIdstringrequired

batchIdstring (uuid)required

update_funnel_lead

Write

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

Permission

marketing-funnels:write

Operation

funnels.leads.update

Module

campaigns

Parameters

cardIdstringrequired

statusstringoptional

ACTIVEWONLOST

lostReasonstringoptional

estimatedValuenumberoptional

update_funnel_rule

Write

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

Permission

marketing-funnels:write

Operation

funnels.rules.update

Module

campaigns

Parameters

ruleIdstringrequired

namestringoptional

triggerstringoptional

MESSAGE_RECEIVEDEMAIL_OPENEDEMAIL_CLICKEDAPPOINTMENT_BOOKEDTAG_ADDEDFORM_SUBMITTEDNO_ACTIVITYPURCHASE_INTENTMANUAL

toStageIdstringoptional

isActivebooleanoptional

fromStageIdstringoptional

Só leads nesta etapa. Nulo = qualquer.

conditionsobject[]optional

conditions[].fieldstringrequired

messageBodychanneltagNameemailTypeidleDays

conditions[].operatorstringrequired

existsequalsnot_equalscontainsgtelte

conditions[].valueanyoptional

actionsobject[]optional

actions[].typestringrequired

add_tagsend_webhookmark_lostnotify

actions[].paramsobjectoptional

orderintegeroptional

update_marketing_funnel

Write

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

Permission

marketing-funnels:write

Operation

funnels.update

Module

campaigns

Parameters

funnelIdstringrequired

namestringoptional

isActivebooleanoptional

descriptionstringoptional

stagesobject[]optional

stages[].idstringoptional

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

stages[].namestringrequired

stages[].orderintegerrequired

stages[].colorstringoptional

stages[].isInitialbooleanoptional

Onde o lead entra.

stages[].isGoalbooleanoptional

Chegar aqui ganha o lead.

staleDaysintegeroptional

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

autoCreateDealbooleanoptional

Ganhar o lead cria um negócio em vendas.

dealStageIdstringoptional

Etapa de vendas onde o negócio nasce.

upsert_stage_cadence

Write

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.

Permission

marketing-funnels:write

Operation

funnels.cadence.upsert

Module

campaigns

Parameters

stageIdstringrequired

isActivebooleanoptional

onExhauststringrequired

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

onExhaustStageIdstringoptional

Etapa de destino (MOVE_STAGE).

stepsobject[]required

steps[].idstringoptional

steps[].orderintegeroptional

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

steps[].delayMinutesintegerrequired

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

steps[].channelstringrequired

EMAILWHATSAPP

steps[].subjectstringoptional

steps[].bodystringrequired

Texto. Vazio quando o passo usa templateId.

steps[].templateIdstringoptional

Modelo aprovado (WhatsApp) no lugar do texto.

steps[].isBreakupbooleanoptional

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