API e MCP do GorilaForms
Referência completa para integrar o GorilaForms com o seu sistema: leia negócios, etapas, histórico medido, tarefas e formulários pela API REST, receba eventos por webhook e opere a conta inteira por agentes de IA com o servidor MCP.
URL base
https://www.gorilaforms.app/api/public
Primeira chamada
curl 'https://www.gorilaforms.app/api/public/crm/pipelines' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
Respostas em JSON, UTF-8. Datas em ISO 8601 (UTC). Toda resposta de sucesso vem dentro de data.
Autenticação
Toda chamada usa uma chave de API da conta no header Authorization: Bearer gf_live_.... A mesma chave vale para a API REST e para o MCP.
- No GorilaForms, abra Configurações > API Keys.
- Crie uma chave com um nome que identifique o uso (ex.: "ERP produção").
- Copie na hora: a chave completa aparece uma única vez. Guardamos só o hash.
Recursos de CRM, WhatsApp e boa parte do MCP exigem a Plataforma 2.0 no plano da conta. Fora dela a resposta é 403.
Authorization: Bearer gf_live_xxxxxxxxxxxxxxxxxxxxxxxx
{ "error": "Chave de API ausente. Use o header Authorization: Bearer gf_live_..." }Paginação e sincronização
Os endpoints de CRM (/crm/deals, /crm/tasks, /crm/deals/events) usam cursor e ordem estável por data de atualização e id. Nada se perde nem se repete entre páginas, mesmo com registros mudando durante a leitura.
- Primeira carga: chame sem
cursore sigapagination.nextCursoratéhasMoreser false. - Incremental: guarde o maior
updatedAtlido e use emupdatedSincena próxima rodada. - Para tempo real, combine com os webhooks. A varredura incremental continua sendo a rede de segurança.
Os endpoints de formulário usam página numerada (page e limit).
let cursor = null
const since = lastSync ?? '2026-01-01T00:00:00-03:00'
do {
const url = new URL('https://www.gorilaforms.app/api/public/crm/deals')
url.searchParams.set('updatedSince', since)
url.searchParams.set('limit', '200')
if (cursor) url.searchParams.set('cursor', cursor)
const res = await fetch(url, { headers: { Authorization: 'Bearer ' + KEY } })
const { data, pagination } = await res.json()
await salvar(data)
cursor = pagination.nextCursor
} while (cursor)Erros e limites
| Código | Quando acontece |
|---|---|
| 400 | Dados inválidos (corpo, parâmetro ou data fora do formato ISO 8601). O campo details traz o problema. |
| 401 | Chave ausente, com formato errado ou inválida. |
| 402 | Limite do plano atingido (ex.: número de formulários). |
| 403 | Conta inativa ou recurso fora do plano (CRM, WhatsApp e MCP de CRM exigem a Plataforma 2.0). |
| 404 | Recurso não encontrado ou de outra conta. A API nunca revela registros de terceiros. |
| 409 | Envio de email bloqueado: o domínio de envio da conta não está verificado (código email_domain_blocked). |
| 500 | Erro interno. Pode repetir a chamada. |
Limites
limitmáximo de 200 por página nos endpoints de CRM e 100 em leads de formulário.- No MCP, mais de 20 mudanças de status por minuto na conta exigem
confirmBulk=trueemupdate_lead. - Envio automático de WhatsApp para contato frio respeita intervalo de 3 a 6 minutos entre contatos.
{
"error": "Dados inválidos",
"details": [ { "path": ["name"], "message": "Required" } ]
}Novidades da 2.0
O que entrou nas últimas atualizações. Histórico completo no changelog.
- A ação prospeccao.create_order (comprar saldo de prospecção) saiu do MCP. Compra de saldo é feita só pela tela Saldo.
- As descrições das tools passaram a só descrever o comportamento: sem confirmToken a ação não executa e devolve a prévia; com ele, executa.
- Novas tools por área: crm_config, leads_admin, automations_admin, cadences_admin, templates_admin, email_admin, whatsapp_admin, lists, agenda, proposals, prospeccao, integrations, reports, users, settings e ai_agents. Cada uma recebe action, params, data e asUserEmail.
- As ações usam as mesmas rotas da tela: mesma validação, mesmo papel do usuário (asUserEmail; sem ele, o dono da conta) e mesma auditoria.
- Toda ação que cria, altera, exclui ou envia devolve primeiro uma prévia (status confirmacao_necessaria) com o que acontece na operação: leads afetados, automações e cadências que usam o registro, o que para e o que não volta. Só executa na 2ª chamada com o confirmToken, que vale 15 min e só para os mesmos argumentos e o mesmo estado do registro.
- As tools de escrita que já existiam (create_lead, update_lead, move_lead, envios, modelos, cadências, automações, campanhas, create_form e duplicate_form) passaram a pedir a mesma confirmação. update_lead com dryRun=true continua só simulando.
- Fora do MCP, de propósito: chaves de API, cobrança e plano, senha e exclusão da conta.
- O servidor MCP aceita login OAuth 2.1 (código de autorização com PKCE S256, registro dinâmico de cliente e Client ID Metadata Document). No Claude, basta adicionar o conector com a URL e entrar com o login do GorilaForms.
- O usuário escolhe a conta na tela de autorização e o app age com o papel dele nela. Token de acesso de 1 hora, renovação com rotação e desconexão em Configurações, API Keys.
- tools/list traz título e anotações (readOnlyHint, destructiveHint) em toda tool; initialize negocia a versão do protocolo e manda as instruções de uso.
- Novas tools get_form, create_form, duplicate_form, update_form e delete_form.
- Editar um formulário que já existe sempre mostra antes a prévia (o que muda, se está no ar, leads recentes e integrações) e só grava com confirm=true e a version da prévia. Se o formulário mudou depois da prévia, a gravação é recusada.
- duplicate_form pode trocar o tipo (padrão, chat ou botão de WhatsApp) e já configurar o Pixel na cópia.
- delete_form só exclui formulário sem leads. Com leads, a saída é tirar do ar (active=false).
Listar funis
Funis da conta com as etapas em ordem. O funil padrão vem primeiro. Use para montar o De/Para de etapas.
Sem parâmetros.
Disponível desde 25/10/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/crm/pipelines' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{
"data": [
{
"id": "cm1pipe...",
"name": "Funil de vendas",
"order": 0,
"isDefault": true,
"stages": [
{ "id": "cm1stg...", "name": "Lead", "order": 0, "isWon": false, "isLost": false },
{ "id": "cm1stg...", "name": "Reunião agendada", "order": 1, "isWon": false, "isLost": false },
{ "id": "cm1stg...", "name": "Ganho", "order": 5, "isWon": true, "isLost": false }
]
}
]
}Listar negócios (incremental)
Endpoint principal de sincronização. Devolve os negócios em ordem de atualização (updatedAt, id) com paginação por cursor. Ideal para puxar só o que mudou desde a última leitura.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| updatedSincestring (ISO 8601) | query | Só registros alterados a partir desta data. Use com fuso, ex.: 2026-11-01T00:00:00-03:00. |
| cursorstring | query | Cursor opaco devolvido em pagination.nextCursor. Envie para buscar a próxima página. |
| limitnumber | query | Itens por página, de 1 a 200. Padrão 100. |
| pipelineIdstring | query | Filtra por funil. No funil padrão, entram também os negócios sem etapa gravada. |
| includeArchivedboolean | query | Inclui negócios arquivados. Padrão false. |
| includeSpamboolean | query | Inclui leads marcados como spam ou em revisão. Padrão false. |
Observações
- status: em_andamento, ganho, perdido ou pausado.
- value em reais, com 2 casas.
- Negócio sem etapa gravada sai na 1ª etapa do funil padrão, igual ao quadro do CRM (desde 11/11/2026).
- Leads de chat incompletos (parciais) nunca entram. Spam rejeitado ou em revisão fica fora por padrão.
- customFields usa o rótulo legível do campo como chave.
Disponível desde 25/10/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/crm/deals?updatedSince=2026-11-01T00:00:00-03:00&limit=100' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{
"data": [
{
"id": "cm1lead...",
"name": "Maria Souza",
"createdAt": "2026-11-10T14:03:22.000Z",
"updatedAt": "2026-11-12T09:41:00.000Z",
"pipeline": { "id": "cm1pipe...", "name": "Funil de vendas" },
"stage": { "id": "cm1stg...", "name": "Reunião agendada", "order": 1 },
"status": "em_andamento",
"lostReason": null,
"lostReasonNote": null,
"lostReasonLmv": null,
"statusChangedAt": null,
"closedAt": null,
"value": 4500,
"product": "Plano Pro",
"owner": { "id": "cm1usr...", "name": "Willy", "email": "willy@empresa.com" },
"contact": { "name": "Maria Souza", "email": "maria@acme.com", "phone": "41999998888", "company": "Acme", "jobTitle": "Diretora" },
"utm": { "source": "facebook", "medium": "cpc", "campaign": "CA_SLG", "content": null, "term": null, "adset": null },
"customFields": { "Faturamento": "R$ 50 mil a R$ 100 mil" }
}
],
"pagination": { "nextCursor": "eyJ1cGRhdGVkQXQiOi...", "hasMore": true }
}Histórico de etapa e status
Histórico MEDIDO de mudanças de etapa e de status (de onde saiu, para onde foi e quando). É append-only: um evento nunca muda depois de criado.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| updatedSincestring (ISO 8601) | query | Só eventos criados a partir desta data (ISO 8601 com fuso). |
| cursorstring | query | Cursor opaco devolvido em pagination.nextCursor. Envie para buscar a próxima página. |
| limitnumber | query | Itens por página, de 1 a 200. Padrão 100. |
| typesstring (csv) | query | Tipos de evento. Padrão stage_changed,status_changed. |
Observações
- source = auto quando quem moveu foi uma automação, cadência ou o MCP. Movimento feito por pessoa sai como manual.
Disponível desde 25/10/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/crm/deals/events?updatedSince=2026-11-01T00:00:00-03:00&limit=100' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{
"data": [
{
"id": "cm1evt...",
"dealId": "cm1lead...",
"type": "stage_changed",
"source": "manual",
"createdAt": "2026-11-12T09:41:00.000Z",
"from": { "id": "cm1stg...", "name": "Lead" },
"to": { "id": "cm1stg...", "name": "Reunião agendada" }
},
{
"id": "cm1evt...",
"dealId": "cm1lead...",
"type": "status_changed",
"source": "manual",
"createdAt": "2026-11-14T16:00:00.000Z",
"from": null,
"to": { "id": null, "name": "ganho" }
}
],
"pagination": { "nextCursor": null, "hasMore": false }
}Listar tarefas
Tarefas dos negócios (ligação, reunião, WhatsApp, email etc.). Notas e eventos de sistema não entram.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| dealIdsstring (csv) | query | Até 100 ids de negócio. Sem ele, use updatedSince. |
| updatedSincestring (ISO 8601) | query | Só registros alterados a partir desta data. Use com fuso, ex.: 2026-11-01T00:00:00-03:00. |
| cursorstring | query | Cursor opaco devolvido em pagination.nextCursor. Envie para buscar a próxima página. |
| limitnumber | query | Itens por página, de 1 a 200. Padrão 100. |
Observações
- recordingUrl é sempre um link assinado e com validade. A URL original do provedor de telefonia nunca é exposta.
Disponível desde 25/10/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/crm/tasks?updatedSince=2026-11-01T00:00:00-03:00&limit=100' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{
"data": [
{
"id": "cm1act...",
"dealId": "cm1lead...",
"type": "task",
"taskKind": "call",
"subject": "Ligar para confirmar a reunião",
"notes": null,
"dueAt": "2026-11-13T13:00:00.000Z",
"doneAt": null,
"done": false,
"createdAt": "2026-11-12T10:00:00.000Z",
"updatedAt": "2026-11-12T10:00:00.000Z",
"createdBy": { "id": "cm1usr...", "name": "Willy" },
"recordingUrl": "https://www.gorilaforms.app/api/public/crm/recording/eyJ..."
}
],
"pagination": { "nextCursor": null, "hasMore": false }
}Listar usuários
Vendedores e donos de negócio da conta.
Sem parâmetros.
Disponível desde 25/10/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/crm/users' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{
"data": [
{ "id": "cm1usr...", "name": "Willy", "email": "willy@empresa.com", "active": true }
]
}Catálogo de campos
Campos de todos os formulários da conta, sem duplicar, com as opções (value e label). Campos internos e ocultos ficam de fora.
Sem parâmetros.
Observações
- O lead guarda o LABEL da opção. Para casar valores vindos de /crm/deals, compare pelo label.
Disponível desde 25/10/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/crm/fields' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{
"data": [
{
"key": "faturamento",
"label": "Faturamento mensal",
"type": "select",
"origin": "form",
"formId": "gorilaforms-20261002-slg-x1y0",
"options": [
{ "value": "ate-50", "label": "Até R$ 50 mil" },
{ "value": "50-100", "label": "R$ 50 mil a R$ 100 mil" }
]
}
]
}Quadro do CRM
Funil, etapas e leads como aparecem no quadro do CRM. Para sincronizar volume, prefira /crm/deals.
Sem parâmetros.
Disponível desde 09/10/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/crm/board' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{ "data": { "pipeline": { "id": "cm1pipe...", "name": "Funil de vendas" }, "stages": [ { "id": "cm1stg...", "name": "Lead", "leads": [ ... ] } ] } }Listar formulários
Formulários da conta, do mais recente para o mais antigo, com a contagem de leads.
Sem parâmetros.
Disponível desde 14/08/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/forms' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{
"data": [
{
"id": "gorilaforms-20261002-slg-x1y0",
"name": "LP SLG /solicitar-demo",
"fields": [ { "name": "nome", "label": "Nome", "type": "text", "required": true } ],
"layout": { ... }, "theme": { ... }, "button": { ... },
"webhookUrl": null, "redirectUrl": null, "successMsg": "Obrigado!",
"antiSpam": { ... },
"createdAt": "2026-10-02T13:00:00.000Z",
"updatedAt": "2026-11-10T18:22:00.000Z",
"_count": { "leads": 812 }
}
]
}Criar formulário
Cria um formulário em branco ou a partir de modelo. Respeita o limite de formulários do plano.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| nameobrigatóriostring | body | Nome do formulário (1 a 100 caracteres). |
| template"blank" | "melius" | body | Modelo inicial. Padrão blank. |
Observações
- 402 quando o plano já está no limite de formulários.
Disponível desde 14/08/2026.
curl -X POST 'https://www.gorilaforms.app/api/public/forms' \
-H 'Authorization: Bearer gf_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "name": "LP Black Friday", "template": "blank" }'{ "data": { "id": "gorilaforms-20261116-lp-black-friday-a1b2", "name": "LP Black Friday", ... } }Detalhar formulário
Configuração completa de um formulário da conta.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| formIdobrigatóriostring | path | Id do formulário. |
Disponível desde 14/08/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/forms/gorilaforms-20261002-slg-x1y0' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{ "data": { "id": "gorilaforms-...", "name": "...", "fields": [ ... ], ... } }Atualizar formulário
Altera só os campos enviados. Segredos (tokens de integração) não são editáveis por aqui.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| formIdobrigatóriostring | path | Id do formulário. |
| namestring | body | Novo nome. |
| webhookUrlstring | null | body | URL que recebe cada lead. |
| redirectUrlstring | null | body | Página de obrigado. |
| successMsgstring | null | body | Mensagem de sucesso (até 500). |
| fields / layout / theme / button / antiSpamobject | body | Estrutura do formulário, no mesmo formato devolvido pelo GET. |
Disponível desde 14/08/2026.
curl -X PATCH 'https://www.gorilaforms.app/api/public/forms/gorilaforms-20261002-slg-x1y0' \
-H 'Authorization: Bearer gf_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "successMsg": "Recebemos! Em breve falamos com você." }'{ "data": { "id": "gorilaforms-...", "successMsg": "Recebemos! Em breve falamos com você.", ... } }Leads do formulário
Leads de um formulário, do mais novo para o mais antigo, com paginação por página.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| formIdobrigatóriostring | path | Id do formulário. |
| pagenumber | query | Página, a partir de 1. |
| limitnumber | query | Itens por página, de 1 a 100. Padrão 50. |
Disponível desde 14/08/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/forms/gorilaforms-20261002-slg-x1y0/leads' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{
"data": [
{
"id": "cm1lead...",
"data": { "nome": "Maria Souza", "email": "maria@acme.com", "empresa": "Acme" },
"createdAt": "2026-11-10T14:03:22.000Z",
"utmSource": "facebook", "utmMedium": "cpc", "utmCampaign": "CA_SLG",
"utmContent": null, "utmTerm": null, "utmAdset": null,
"qualified": true,
"spamReview": "valid"
}
],
"pagination": { "page": 1, "limit": 50, "total": 812, "totalPages": 17 }
}Métricas do formulário
Visualizações, visualizações engajadas, leads e taxa de conversão.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| formIdobrigatóriostring | path | Id do formulário. |
Disponível desde 14/08/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/forms/gorilaforms-20261002-slg-x1y0/metrics' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{ "data": { "formId": "gorilaforms-...", "views": 10234, "delayedViews": 8120, "engagedViews": 3011, "leads": 812, "conversionRate": 0.0793 } }Código de incorporação
Snippet pronto para colar na landing page.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| formIdobrigatóriostring | path | Id do formulário. |
Disponível desde 14/08/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/forms/gorilaforms-20261002-slg-x1y0/embed' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{ "data": { "formId": "gorilaforms-...", "snippet": "<script src=\"https://www.gorilaforms.app/e/...\"></script>" } }Listar webhooks
Endpoints de webhook cadastrados na conta. O segredo vem mascarado (secret_hint).
Sem parâmetros.
Disponível desde 16/11/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/crm/webhooks' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{
"data": [
{
"id": "cm3wh...",
"url": "https://sistema.empresa.com/gorila/webhook",
"events": ["deal.created", "deal.stage_changed"],
"active": true,
"secret_hint": "whsec_AbCd...9xYz",
"created_at": "2026-11-16T18:30:00.000Z"
}
]
}Cadastrar webhook
Cadastra uma URL para receber os eventos de negócio. O segredo whsec_ volta só nesta resposta: guarde para validar a assinatura.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| urlobrigatóriostring | body | URL HTTPS pública. localhost e IP privado são recusados. |
| eventsobrigatóriostring[] | body | Um ou mais de: deal.created, deal.stage_changed, deal.status_changed. |
| activeboolean | body | Começa ativo. Padrão true. |
Observações
- Até 10 webhooks por conta (409 ao passar do limite).
- Depois de cadastrar, chame /crm/webhooks/{id}/test para conferir a entrega.
Disponível desde 16/11/2026.
curl -X POST 'https://www.gorilaforms.app/api/public/crm/webhooks' \
-H 'Authorization: Bearer gf_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "url": "https://sistema.empresa.com/gorila/webhook", "events": ["deal.created", "deal.stage_changed", "deal.status_changed"] }'{
"data": {
"id": "cm3wh...",
"url": "https://sistema.empresa.com/gorila/webhook",
"events": ["deal.created", "deal.stage_changed", "deal.status_changed"],
"active": true,
"secret": "whsec_AbCdEfGh...",
"created_at": "2026-11-16T18:30:00.000Z"
}
}Detalhar webhook
Um webhook da conta, com o segredo mascarado.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| idobrigatóriostring | path | Id do webhook. |
Disponível desde 16/11/2026.
curl -X GET 'https://www.gorilaforms.app/api/public/crm/webhooks/cm3wh8x2k0001' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{ "data": { "id": "cm3wh...", "url": "https://...", "events": ["deal.created"], "active": true, "secret_hint": "whsec_AbCd...9xYz", "created_at": "..." } }Atualizar webhook
Altera só o que for enviado: URL, eventos, pausar/reativar ou gerar um segredo novo.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| idobrigatóriostring | path | Id do webhook. |
| urlstring | body | Nova URL HTTPS pública. |
| eventsstring[] | body | Nova lista de eventos (substitui a anterior). |
| activeboolean | body | false pausa os envios sem apagar o cadastro. |
| rotate_secretboolean | body | true gera um segredo novo, que volta só nesta resposta. O antigo deixa de valer na hora. |
Disponível desde 16/11/2026.
curl -X PATCH 'https://www.gorilaforms.app/api/public/crm/webhooks/cm3wh8x2k0001' \
-H 'Authorization: Bearer gf_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "active": false }'{ "data": { "id": "cm3wh...", "active": false, "secret_hint": "whsec_AbCd...9xYz", ... } }Remover webhook
Apaga o cadastro. Os envios param na hora.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| idobrigatóriostring | path | Id do webhook. |
Disponível desde 16/11/2026.
curl -X DELETE 'https://www.gorilaforms.app/api/public/crm/webhooks/cm3wh8x2k0001' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{ "ok": true }Testar webhook
Envia um evento ping assinado para a URL e devolve o status HTTP que ela respondeu.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| idobrigatóriostring | path | Id do webhook. |
Observações
- O corpo do ping é { "event": "ping", "webhookId", "accountId", "at" }, com a mesma assinatura X-Gorila-Signature dos eventos reais.
Disponível desde 16/11/2026.
curl -X POST 'https://www.gorilaforms.app/api/public/crm/webhooks/cm3wh8x2k0001/test' \ -H 'Authorization: Bearer gf_live_SUA_CHAVE'
{ "data": { "delivered": true, "status": 200, "duration_ms": 184 } }Enviar mensagem
Envia um texto pelo WhatsApp conectado da conta.
Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
| numberobrigatóriostring | body | Número com DDD (DDI 55 é adicionado se faltar). |
| textobrigatóriostring | body | Texto, até 4096 caracteres. |
Observações
- Para registrar na linha do tempo do lead, use a tool send_lead_whatsapp do MCP.
Disponível desde 09/10/2026.
curl -X POST 'https://www.gorilaforms.app/api/public/whatsapp/send' \
-H 'Authorization: Bearer gf_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "number": "41999998888", "text": "Oi Maria, tudo bem?" }'{ "data": { "id": "3EB0A1B2C3D4E5F6" } }Webhooks
NovoPlataforma 2.0O GorilaForms envia um POST em JSON para a sua URL (HTTPS) quando um negócio muda. Cadastre a URL você mesmo pela API, em POST /crm/webhooks, e confira a entrega com o teste. O segredo whsec_... volta uma única vez, no cadastro (ou ao rotacionar).
| Evento | Descrição |
|---|---|
| deal.created | Negócio criado (form, Lead Ads, agenda, cadastro manual ou envio para funil). |
| deal.stage_changed | Negócio mudou de etapa. |
| deal.status_changed | Negócio virou ganho, perdido, pausado ou voltou para em andamento. |
| ping | Só no teste (/crm/webhooks/{id}/test). Não é preciso assinar. |
Assinatura
Cada envio traz X-Gorila-Event: crm e X-Gorila-Signature, que é o HMAC SHA-256 (hex) do corpo cru com o seu segredo. Compare antes de processar.
Entrega
- Responda 2xx em até 10 segundos.
- Falhou: uma nova tentativa logo em seguida. Depois disso o evento não é reenviado, então mantenha a sincronização incremental de
/crm/dealscomo rede de segurança. - O corpo traz só o id do negócio: busque os dados atualizados em
/crm/deals.
{
"event": "deal.stage_changed",
"dealId": "cm1lead...",
"accountId": "cm1acc...",
"at": "2026-11-16T18:30:00.000Z"
}import { createHmac, timingSafeEqual } from 'node:crypto'
export function valido(rawBody, assinatura, segredo) {
const esperado = createHmac('sha256', segredo).update(rawBody).digest('hex')
return timingSafeEqual(Buffer.from(esperado), Buffer.from(assinatura ?? ''))
}Servidor MCP
2.0O MCP (Model Context Protocol) deixa um agente de IA operar a conta: ler e mover negócios, criar tarefas, mandar email e WhatsApp pelo lead, montar campanhas, modelos, cadências e automações, e configurar a conta (funil, listas, agenda, integrações, usuários). São 57 tools, todas presas a uma conta. No Claude, adicione como conector com a URL abaixo e entre com o seu login do GorilaForms.
| URL | https://www.gorilaforms.app/api/mcp |
| Transporte | Streamable HTTP (JSON-RPC 2.0 via POST) |
| Protocolo | 2025-06-18 |
| Métodos | initialize, tools/list, tools/call, ping. Aceita lote (array). |
| Auth | Login OAuth 2.1 (PKCE S256, registro dinâmico ou CIMD): o app age com o papel do usuário na conta escolhida. Ou a chave da API: Authorization: Bearer gf_live_... |
| Descoberta | /.well-known/oauth-protected-resource e /.well-known/oauth-authorization-server |
Boas práticas
- Toda ação que cria, altera, exclui ou envia devolve antes uma prévia (
status: confirmacao_necessaria) com o impacto na operação e umconfirmToken. Mostre ao usuário e repita a chamada com o token só depois do sim dele. O token vale 15 minutos e só para os mesmos argumentos. - Com chave de API,
asUserEmaildefine quem age (papel, remetente e autor). Sem ele, age o dono da conta. Com login, age sempre quem autorizou. - Fora do MCP, de propósito: chaves de API, cobrança, senha e exclusão da conta.
- Use
update_leadcomdryRun=truepara ver o que mudaria e quais automações disparariam antes de gravar. - Erro de negócio volta como resultado com
isError: truee a mensagem em texto, não como erro de protocolo.
Claude > Configurações > Conectores > Adicionar conector personalizado Nome: GorilaForms URL: https://www.gorilaforms.app/api/mcp Claude Code com login: claude mcp add --transport http gorilaforms https://www.gorilaforms.app/api/mcp
curl -X POST 'https://www.gorilaforms.app/api/mcp' \
-H 'Authorization: Bearer gf_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'Lista os leads mais recentes da conta. Filtra por formId opcional.
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| formId | string | |
| limit | number | máx 100 (default 20) |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_leads",
"arguments": {
"formId": "<formId>",
"limit": 20
}
}
}Detalhe de um lead: dados, etapa, dono, valor e atividades (timeline).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| leadIdobrigatório | string |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_lead",
"arguments": {
"leadId": "<leadId>"
}
}
}Cadastra um lead manual no CRM (como "Novo lead" da tela). stageId opcional (padrão: 1ª etapa do funil padrão). Responsável = asUserEmail ou dono da conta. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| nameobrigatório | string | |
| company | string | |
| string | ||
| phone | string | |
| value | number | |
| stageId | string | |
| pipelineId | string | |
| asUserEmail | string | Email do membro que executa (remetente/autor). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "create_lead",
"arguments": {
"name": "..."
}
}
}Edita o card, igual à tela: ownerId (null limpa), value (null limpa), planId, product, expectedCloseAt (ISO), crmStatus (em_andamento|ganho|perdido|pausado; perdido exige lostReason de list_loss_reasons), stageId, addFields {campo: valor} (preenche só campos vazios), altContact {nome,email,telefone,cargo}. dryRun=true só simula (devolve o que mudaria e quais automações disparariam, sem gravar). Proteção de massa: acima de 20 mudanças de crmStatus por minuto na conta, exige confirmBulk=true (confira antes com dryRun). [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| leadIdobrigatório | string | |
| ownerId | string | null | |
| value | number | null | |
| planId | string | null | |
| product | string | null | |
| expectedCloseAt | string | null | |
| crmStatus | string | |
| lostReason | string | |
| lostReasonNote | string | |
| stageId | string | |
| addFields | object | |
| altContact | object | |
| dryRun | boolean | true = só simula, não grava nada. |
| confirmBulk | boolean | Confirma mudança de status em massa (acima do limite por minuto). |
| asUserEmail | string | Email do membro que executa (remetente/autor). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "update_lead",
"arguments": {
"leadId": "<leadId>"
}
}
}Move um lead (card) para uma etapa do funil. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| leadIdobrigatório | string | |
| stageIdobrigatório | string | |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "move_lead",
"arguments": {
"leadId": "<leadId>",
"stageId": "<stageId>"
}
}
}Retorna o funil do CRM: etapas e leads agrupados por etapa.
Sem argumentos.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "crm_board",
"arguments": {}
}
}Negócios do CRM em forma canônica (etapa/status/valor/contato/UTMs/customFields), incremental. Params: updatedSince (ISO), pipelineId, limit (máx 200). Mesmo dado de GET /crm/deals.
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| updatedSince | string | |
| pipelineId | string | |
| limit | number |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_deals",
"arguments": {
"updatedSince": "...",
"pipelineId": "<pipelineId>"
}
}
}Histórico MEDIDO de etapa/status (from/to). Params: dealId (opcional), types (csv, padrão stage_changed,status_changed), limit. Mesmo dado de GET /crm/deals/events.
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| dealId | string | |
| types | string | |
| limit | number |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_deal_events",
"arguments": {
"dealId": "<dealId>",
"types": "..."
}
}
}Registra uma atividade num lead, igual à tela (type: note|task|call|email|whatsapp). content opcional (nota aceita HTML simples). Tarefa: taskKind (tarefa|ligacao|whatsapp|email|reuniao|documentacao) e dueAt ISO. Isto só REGISTRA; para enviar de verdade use send_lead_email / send_lead_whatsapp. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| leadIdobrigatório | string | |
| typeobrigatório | string | |
| content | string | |
| dueAt | string | |
| taskKind | string | |
| asUserEmail | string | Email do membro que executa (remetente/autor). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "create_activity",
"arguments": {
"leadId": "<leadId>",
"type": "..."
}
}
}Conclui/reabre uma tarefa (done) e/ou muda o prazo (dueAt ISO). Concluir registra na timeline e conta para cadência, igual à tela. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| activityIdobrigatório | string | |
| done | boolean | |
| dueAt | string | |
| asUserEmail | string | Email do membro que executa (remetente/autor). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "update_task",
"arguments": {
"activityId": "<activityId>"
}
}
}Tarefas (Activity type=task) dos negócios. Params: dealIds (csv, opcional), limit. recordingUrl assinada quando houver. Mesmo dado de GET /crm/tasks.
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| dealIds | string | |
| limit | number |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_tasks",
"arguments": {
"dealIds": "...",
"limit": 20
}
}
}Modelos de tarefa do CRM.
Sem argumentos.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_task_templates",
"arguments": {}
}
}Tudo para montar email/campanha: domínio de envio (status verified|pending|failed; sem domínio verificado o email sai por noreply@gorilaforms.app), remetentes possíveis (conta e "enviar como" cada membro), modelos de email (simple=true pode ir no email individual do lead), formulários, listas (cold=true é bloqueada em campanha de email) e funis/etapas para a audiência. audience opcional: devolve a contagem (total, por fonte, suprimidos, sem email) sem enviar nada.
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| audience | object | null | Audiência (somam, sem duplicar): { forms: [formId], lists: [listId], stages: [stageId], qualified: "pos"|"neg"|null (LMV), status: [em_andamento|ganho|perdido|pausado], excludeLists: [], excludeStages: [] }. Vazio/null = toda a base de leads. IDs saem de get_email_context. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_email_context",
"arguments": {
"audience": {}
}
}
}ENVIA um email de verdade para o lead, igual ao "Enviar email" do card: remetente = perfil de asUserEmail (padrão: dono da conta), assinatura, variáveis {{nome}} etc., registra na timeline. to = lista de emails (padrão: email principal do lead). Conteúdo: html + subject OU templateId (modelo de email simples, os mesmos que o card oferece; html/subject enviados junto sobrescrevem). attachments: [{ url, name, contentType, size }] só com arquivo enviado ao GorilaForms (URL *.public.blob.vercel-storage.com), até 10MB no total. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| leadIdobrigatório | string | |
| to | array | |
| subject | string | |
| html | string | |
| templateId | string | Modelo de email (get_email_context.templates com simple=true). |
| attachments | array | |
| asUserEmail | string | Email do membro que executa (remetente/autor). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "send_lead_email",
"arguments": {
"leadId": "<leadId>"
}
}
}Lista as campanhas de email da conta com status e métricas. id opcional retorna a campanha completa (html, audiência, remetente).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| id | string |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_campaigns",
"arguments": {
"id": "<id>"
}
}
}Cria uma campanha de email em RASCUNHO (não envia). name, subject, html OU templateId (copia assunto e corpo do modelo), audience, usePersonal (true = sai como asUserEmail/dono, senão como a conta). scheduledAt ISO futuro agenda o disparo automático e exige confirm=true. Depois: test_campaign, send_campaign. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| nameobrigatório | string | |
| subject | string | |
| html | string | |
| templateId | string | |
| audience | object | null | Audiência (somam, sem duplicar): { forms: [formId], lists: [listId], stages: [stageId], qualified: "pos"|"neg"|null (LMV), status: [em_andamento|ganho|perdido|pausado], excludeLists: [], excludeStages: [] }. Vazio/null = toda a base de leads. IDs saem de get_email_context. |
| usePersonal | boolean | |
| scheduledAt | string | null | |
| confirm | boolean | Obrigatório (true) para agendar: agendamento envia email de verdade sozinho. |
| asUserEmail | string | Email do membro que executa (remetente/autor). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "create_campaign",
"arguments": {
"name": "..."
}
}
}Edita campanha em rascunho ou agendada (só os campos enviados): name, subject, html ou templateId, audience (null = toda a base), usePersonal, scheduledAt (ISO futuro agenda e exige confirm=true; null cancela o agendamento e volta a rascunho). Campanha já enviada não muda. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| idobrigatório | string | |
| name | string | |
| subject | string | |
| html | string | |
| templateId | string | |
| audience | object | null | Audiência (somam, sem duplicar): { forms: [formId], lists: [listId], stages: [stageId], qualified: "pos"|"neg"|null (LMV), status: [em_andamento|ganho|perdido|pausado], excludeLists: [], excludeStages: [] }. Vazio/null = toda a base de leads. IDs saem de get_email_context. |
| usePersonal | boolean | |
| scheduledAt | string | null | |
| confirm | boolean | |
| asUserEmail | string | Email do membro que executa (remetente/autor). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "update_campaign",
"arguments": {
"id": "<id>"
}
}
}Envia a campanha como TESTE (assunto com [TESTE]) para até 5 emails, com valores de exemplo nas variáveis (vars, ex.: { "nome": "Maria" }). Não grava nem conta métrica. campaignId usa o conteúdo salvo; ou mande subject + html (ou templateId). Manda email de verdade: exige confirm=true. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| toobrigatório | array | |
| campaignId | string | |
| subject | string | |
| html | string | |
| templateId | string | |
| vars | object | |
| usePersonal | boolean | |
| confirmobrigatório | boolean | |
| asUserEmail | string | Email do membro que executa (remetente/autor). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "test_campaign",
"arguments": {
"to": [],
"confirm": true
}
}
}DISPARA a campanha de email de verdade para toda a audiência. Exige confirm=true (sem confirm não envia e a resposta diz quantos receberiam). Monta a fila agora (lista fria é bloqueada) e o envio segue em lotes de 25 pelo agendador (motor a cada minuto); acompanhe com list_campaigns(id) e list_campaign_recipients.
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| idobrigatório | string | |
| confirmobrigatório | boolean | |
| asUserEmail | string | Email do membro que executa (remetente/autor). Padrão: dono da conta. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "send_campaign",
"arguments": {
"id": "<id>",
"confirm": true
}
}
}Destinatários de uma campanha com status (queued|sent|failed e os eventos do provedor). status opcional filtra; limit até 1000 (padrão 200). counts traz o total por status.
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| idobrigatório | string | |
| status | string | |
| limit | number |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_campaign_recipients",
"arguments": {
"id": "<id>"
}
}
}ENVIA um WhatsApp de verdade para o lead, igual ao "Enviar WhatsApp" do card (número pessoal de asUserEmail, senão o oficial da conta) e registra na timeline. number só dígitos com DDI. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| leadIdobrigatório | string | |
| numberobrigatório | string | |
| textobrigatório | string | |
| asUserEmail | string | Email do membro que executa (remetente/autor). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "send_lead_whatsapp",
"arguments": {
"leadId": "<leadId>",
"number": "...",
"text": "..."
}
}
}Envia uma mensagem de WhatsApp (instância conectada da conta). number só dígitos com DDI. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| numberobrigatório | string | |
| textobrigatório | string | |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "send_whatsapp",
"arguments": {
"number": "...",
"text": "..."
}
}
}Modelos de email/WhatsApp. channel opcional (email|whatsapp). full=true traz o corpo.
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| channel | string | |
| full | boolean |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_templates",
"arguments": {
"channel": "...",
"full": true
}
}
}Cria modelo de email/WhatsApp com a mesma validação da tela. channel email: subject + body em HTML (sanitizado; se o HTML for do editor Visual, a tela reabre em blocos), pdfUrl/pdfName opcionais (PDF anexado nos envios; só arquivo enviado ao GorilaForms). channel whatsapp: body texto + variants opcionais (até 20 variações). purpose: automation|broadcast|both (padrão both). Nunca use travessão no texto. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| channelobrigatório | string: email, whatsapp | |
| nameobrigatório | string | |
| subject | string | Só email. |
| bodyobrigatório | string | |
| variants | array | Só WhatsApp. |
| purpose | string: automation, broadcast, both | |
| folderId | string | null | |
| pdfUrl | string | null | Só email. URL *.public.blob.vercel-storage.com. |
| pdfName | string | null | |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "create_template",
"arguments": {
"channel": "email",
"name": "...",
"body": "..."
}
}
}Edita modelo de email/WhatsApp (só os campos enviados): name, purpose, subject (email), body, variants (WhatsApp; null limpa), folderId, pdfUrl/pdfName (email; null tira o PDF). Body de email novo substitui a receita do editor Visual: a tela passa a mostrar o conteúdo novo (em blocos se o HTML for do Visual, senão no HTML). [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| idobrigatório | string | |
| name | string | |
| purpose | string: automation, broadcast, both | |
| subject | string | null | |
| body | string | |
| variants | array | null | |
| folderId | string | null | |
| pdfUrl | string | null | |
| pdfName | string | null | |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "update_template",
"arguments": {
"id": "<id>"
}
}
}Lista as automações da conta (gatilho, nº de passos, ativa/pausada).
Sem argumentos.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_automations",
"arguments": {}
}
}Detalhe completo de uma automação (gatilho, triggerConfig, grafo de passos, janela, regras de saída).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| idobrigatório | string |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_automation",
"arguments": {
"id": "<id>"
}
}
}Cria (sem id) ou edita (com id, só os campos enviados) uma automação, com a mesma validação da tela. Campos: name, trigger, triggerConfig, steps (grafo {root,nodes}), scheduleConfig, enabled, exitOnStages, actOnLost, exitOnReply, senderMode. Nasce DESLIGADA salvo enabled=true; ligar exige cadência completa. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| id | string | |
| bodyobrigatório | object | |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "save_automation",
"arguments": {
"body": {}
}
}
}Lista as cadências da conta (id, nome, ativa). id opcional retorna o detalhe completo (itens, regras, repetição).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| id | string |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_cadences",
"arguments": {
"id": "<id>"
}
}
}Cria (sem id) ou substitui (com id) uma cadência com o corpo completo da tela: name, description, days, blockRepeats, schedule, minGapMinutes, items[], rules, repeat, folderId, active, exitOnStages. Para só ligar/desligar/renomear use id + active/name sem items. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| id | string | |
| bodyobrigatório | object | |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "save_cadence",
"arguments": {
"body": {}
}
}
}Lista os formulários da conta (id, nome, ativo, total de leads). Para ler um form inteiro: get_form; criar: create_form ou duplicate_form; editar: update_form (sempre com prévia antes de gravar).
Sem argumentos.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_forms",
"arguments": {}
}
}Lista os funis da conta com as etapas em ordem (isWon/isLost). Mesmo dado de GET /crm/pipelines.
Sem argumentos.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_pipelines",
"arguments": {}
}
}Lista os vendedores/donos de negócio da conta (id, nome, email, active). Mesmo dado de GET /crm/users.
Sem argumentos.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_users",
"arguments": {}
}
}Catálogo de campos dos formulários da conta (name, label, opções). Alimenta seletor de LMV. Mesmo dado de GET /crm/fields.
Sem argumentos.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_fields",
"arguments": {}
}
}Motivos de perda da conta. "value" é o texto exato a usar em update_lead.lostReason.
Sem argumentos.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_loss_reasons",
"arguments": {}
}
}Planos (produtos) do CRM com implantação, mensalidade e contrato.
Sem argumentos.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_plans",
"arguments": {}
}
}Lê a configuração completa de um formulário (campos, aparência, tipo, destino, pixels, LMV, validadores; segredos aparecem só como "(definido)") + o impacto (está no ar, leads nos últimos 30 dias, integrações que disparam com ele) + version. Use antes de editar.
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| idobrigatório | string |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_form",
"arguments": {
"id": "<id>"
}
}
}Cria um formulário NOVO (não mexe em nada existente). name, formType (standard | chat | wa-float; imutável depois), template (blank | melius), copyFromId (copia só campos, aparência e LMV de outro form) e settings opcional para já configurar. Mesmo formato do update_form.changes (name, fields, layout, theme, button, redirectUrl, webhookUrl, successMsg, chatConfig, waFloat, antiSpam, validators, metaPixelId, metaAccessToken, openaiPixelId, openaiLeadEvent, openaiApiKey, googleAdsId, googleAdsLabel, qualifyRule, qualifySource, qualifyOutcome, active). Respeita o limite de formulários do plano. Devolve id e link do editor. [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| nameobrigatório | string | |
| formType | string: standard, chat, wa-float | |
| template | string: blank, melius | |
| copyFromId | string | |
| settings | object | Mesmo formato do update_form.changes (name, fields, layout, theme, button, redirectUrl, webhookUrl, successMsg, chatConfig, waFloat, antiSpam, validators, metaPixelId, metaAccessToken, openaiPixelId, openaiLeadEvent, openaiApiKey, googleAdsId, googleAdsLabel, qualifyRule, qualifySource, qualifyOutcome, active). |
| asUserEmail | string | Email do membro que executa (autor na auditoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "create_form",
"arguments": {
"name": "..."
}
}
}Duplica um formulário em um NOVO (o original não muda): copia campos, aparência, destino (redirect/webhook/mensagem), anti-spam, validadores e LMV. Pixels e tokens NÃO são copiados (passe em settings). Pode trocar o tipo (formType: standard | chat | wa-float) e o nome (padrão "<nome> (cópia)"). Formulário do Meta Lead Ads não duplica. Mesmo formato do update_form.changes (name, fields, layout, theme, button, redirectUrl, webhookUrl, successMsg, chatConfig, waFloat, antiSpam, validators, metaPixelId, metaAccessToken, openaiPixelId, openaiLeadEvent, openaiApiKey, googleAdsId, googleAdsLabel, qualifyRule, qualifySource, qualifyOutcome, active). [Com confirmação: sem confirmToken a chamada não executa e devolve a prévia com o impacto e um confirmToken; com o confirmToken (mesmos argumentos), executa.]
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| idobrigatório | string | |
| name | string | |
| formType | string: standard, chat, wa-float | |
| settings | object | Mesmo formato do update_form.changes (name, fields, layout, theme, button, redirectUrl, webhookUrl, successMsg, chatConfig, waFloat, antiSpam, validators, metaPixelId, metaAccessToken, openaiPixelId, openaiLeadEvent, openaiApiKey, googleAdsId, googleAdsLabel, qualifyRule, qualifySource, qualifyOutcome, active). |
| asUserEmail | string | Email do membro que executa (autor na auditoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "duplicate_form",
"arguments": {
"id": "<id>"
}
}
}Edita um formulário QUE JÁ EXISTE. Sem confirm=true NÃO grava: devolve a prévia (o que muda, campo a campo), o impacto (no ar, leads recentes, integrações) e a version. Com confirm=true e a mesma version, grava; se o form mudou depois da prévia, a gravação é recusada (leia de novo). changes: só o que muda. Mesmo formato do update_form.changes (name, fields, layout, theme, button, redirectUrl, webhookUrl, successMsg, chatConfig, waFloat, antiSpam, validators, metaPixelId, metaAccessToken, openaiPixelId, openaiLeadEvent, openaiApiKey, googleAdsId, googleAdsLabel, qualifyRule, qualifySource, qualifyOutcome, active). fields substitui a LISTA INTEIRA de campos (leia com get_form, altere e mande tudo). formType não muda (use duplicate_form). active=false tira o form do ar.
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| idobrigatório | string | |
| changesobrigatório | object | Mesmo formato do update_form.changes (name, fields, layout, theme, button, redirectUrl, webhookUrl, successMsg, chatConfig, waFloat, antiSpam, validators, metaPixelId, metaAccessToken, openaiPixelId, openaiLeadEvent, openaiApiKey, googleAdsId, googleAdsLabel, qualifyRule, qualifySource, qualifyOutcome, active). |
| confirm | boolean | |
| version | string | version devolvida pela prévia (ou get_form). |
| asUserEmail | string | Email do membro que executa (autor na auditoria). Padrão: dono da conta. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "update_form",
"arguments": {
"id": "<id>",
"changes": {}
}
}
}Exclui um formulário. Só é permitido quando o formulário NÃO tem nenhum lead (excluir apaga os leads junto); com leads, use update_form com active=false. Sem confirm=true só mostra a prévia. Formulário do Meta Lead Ads não se exclui aqui.
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| idobrigatório | string | |
| confirm | boolean | |
| version | string | |
| asUserEmail | string | Email do membro que executa (autor na auditoria). Padrão: dono da conta. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "delete_form",
"arguments": {
"id": "<id>"
}
}
}Configuração do CRM: funis, etapas, motivos de perda, planos (produtos), modelos de tarefa, equipes de distribuição e pastas de modelos. Ações: - list_pipelines: Listar funis e etapas - create_pipeline [cria, pede confirmação]: Criar funil. data: { name } - rename_pipeline [altera, pede confirmação]: Renomear funil. params: { pipelineId }, data: { name } - delete_pipeline [exclui, pede confirmação]: Excluir funil. params: { pipelineId } - add_stage [cria, pede confirmação]: Criar etapa. params: { pipelineId }, data: { name, color? } - reorder_stages [altera, pede confirmação]: Reordenar etapas. params: { pipelineId }, data: { order: [stageId, ...] } (todas as etapas, na ordem nova) - update_stage [altera, pede confirmação]: Alterar etapa. params: { stageId }, data: { name?, color?, isWon?, isLost?, entryRule?, exitRule? } (regra: { logic: and|or, conditions: [{ field, op, value }] } ou null) - delete_stage [exclui, pede confirmação]: Excluir etapa. params: { stageId } - get_loss_reasons: Ver motivos de perda - replace_loss_reasons [altera, pede confirmação]: Substituir motivos de perda. data: { reasons: [{ label, lmv?: pos|neg|null, active? }] } (lista inteira, na ordem) - list_plans: Listar planos - create_plan [cria, pede confirmação]: Criar plano. data: { name, contractMonths?, setupValue?, monthlyValue?, folderId? } - update_plan [altera, pede confirmação]: Alterar plano. params: { planId }, data: { name?, contractMonths?, setupValue?, monthlyValue?, active?, folderId? } - delete_plan [exclui, pede confirmação]: Excluir plano. params: { planId } - list_task_templates: Listar modelos de tarefa - create_task_template [cria, pede confirmação]: Criar modelo de tarefa. data: { name, kind?, folderId? } - update_task_template [altera, pede confirmação]: Alterar modelo de tarefa. params: { id }, data: { name?, kind?, active?, folderId? } - delete_task_template [exclui, pede confirmação]: Excluir modelo de tarefa. params: { id } - get_teams: Ver equipes e regras de distribuição - replace_teams [altera, pede confirmação]: Substituir equipes e distribuição. data: { teams: [{ key, id?, name, memberIds }], rules: [{ formId|null, teamKey }] } (configuração inteira; leia get_teams antes) - list_folders: Listar pastas de modelos - create_folder [cria, pede confirmação]: Criar pasta. data: { kind: email|whatsapp|task|plan|cadence, name, parentId? } - update_folder [altera, pede confirmação]: Alterar pasta. params: { id }, data: { name?, parentId? } - delete_folder [exclui, pede confirmação]: Excluir pasta. params: { id } Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: list_pipelines, create_pipeline, rename_pipeline, delete_pipeline, add_stage, reorder_stages, update_stage, delete_stage, get_loss_reasons, replace_loss_reasons, list_plans, create_plan, update_plan, delete_plan, list_task_templates, create_task_template, update_task_template, delete_task_template, get_teams, replace_teams, list_folders, create_folder, update_folder, delete_folder | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "crm_config",
"arguments": {
"action": "list_pipelines"
}
}
}Leads além do básico: busca e exportação da base, tirar do funil, colocar/tirar de automação, editar ou apagar atividade, revisão de spam, histórico e ligar para o lead. Ações: - search_leads: Buscar leads (tela Leads). params: { formId?, campaign?, from?, to?, q?, spamReview?: valid|pending|approved|rejected|all, partial?: 1, page? } - export_leads: Exportar leads (CSV). params: mesmos filtros de search_leads - lead_log: Histórico técnico do lead (eventos e integrações). params: { leadId } - lead_automations: Automações/cadências em andamento do lead. params: { leadId } - tasks_of_leads: Tarefas de uma lista de leads. data: { leadIds: [...] } - manual_automations: Automações que aceitam entrada manual - remove_from_board [exclui, pede confirmação]: Tirar lead do funil. params: { leadId } - enroll_automation [envia, pede confirmação]: Colocar lead numa automação. params: { leadId }, data: { automationId } - remove_from_automation [altera, pede confirmação]: Tirar lead da automação. params: { leadId, runId } (runId de lead_automations) - update_activity [altera, pede confirmação]: Alterar atividade. params: { activityId }, data: { done?, hidden?, pinned?, dueAt? } - delete_activity [exclui, pede confirmação]: Apagar atividade. params: { activityId } - review_lead [altera, pede confirmação]: Aprovar ou rejeitar lead em revisão de spam. params: { leadId }, data: { action: approve|reject } - call_lead [envia, pede confirmação]: Ligar para o lead (telefonia). data: { leadId, phone? } Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: search_leads, export_leads, lead_log, lead_automations, tasks_of_leads, manual_automations, remove_from_board, enroll_automation, remove_from_automation, update_activity, delete_activity, review_lead, call_lead | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "leads_admin",
"arguments": {
"action": "search_leads"
}
}
}Automações além de criar/editar (save_automation): ligar, pausar, duplicar, excluir, ver execuções e quantos leads casam com um gatilho. Ações: - list_runs: Execuções da automação. params: { id } - match_count: Quantos leads casam com um gatilho. data: { trigger, triggerConfig } - pause [altera, pede confirmação]: Pausar automação. params: { id } - activate [altera, pede confirmação]: Ligar automação. params: { id } - duplicate [cria, pede confirmação]: Duplicar automação. params: { id } - delete [exclui, pede confirmação]: Excluir automação. params: { id } Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: list_runs, match_count, pause, activate, duplicate, delete | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "automations_admin",
"arguments": {
"action": "list_runs"
}
}
}Cadências além de criar/editar (save_cadence): ativar, desativar e excluir. Ações: - pause [altera, pede confirmação]: Desativar cadência. params: { id } - activate [altera, pede confirmação]: Ativar cadência. params: { id } - delete [exclui, pede confirmação]: Excluir cadência. params: { id } Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: pause, activate, delete | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "cadences_admin",
"arguments": {
"action": "pause"
}
}
}Modelos de email/WhatsApp além de criar/editar: excluir. Ações: - delete [exclui, pede confirmação]: Excluir modelo. params: { id } Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: delete | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "templates_admin",
"arguments": {
"action": "delete"
}
}
}Email além das campanhas: excluir campanha, domínio de envio (ver, cadastrar, verificar, remover) e audiência. Ações: - get_domain: Ver domínio de envio e DNS - audience: Audiência disponível para email. params: filtros da tela - delete_campaign [exclui, pede confirmação]: Excluir campanha de email. params: { id } - add_domain [cria, pede confirmação]: Cadastrar domínio de envio. data: { domain, fromName?, fromLocal? } (devolve os registros DNS) - verify_domain [altera, pede confirmação]: Verificar domínio (DNS) - delete_domain [exclui, pede confirmação]: Remover domínio de envio Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: get_domain, audience, delete_campaign, add_domain, verify_domain, delete_domain | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "email_admin",
"arguments": {
"action": "get_domain"
}
}
}WhatsApp da conta: status, conectar (QR Code), desconectar, mensagens, campanhas de WhatsApp (criar, editar, disparar, destinatários) e audiência. Ações: - status: Status da conexão - messages: Mensagens de uma conversa. params: { number, after? } - list_campaigns: Listar campanhas de WhatsApp - campaign_recipients: Destinatários da campanha. params: { id } - audience: Audiência disponível para WhatsApp. params: filtros da tela - connect [altera, pede confirmação]: Conectar WhatsApp (gera QR Code). data: {} (devolve o QR Code para ler no celular) - disconnect [exclui, pede confirmação]: Desconectar WhatsApp - create_campaign [cria, pede confirmação]: Criar campanha de WhatsApp (rascunho). data: { name, body, audience?, segmentFormId?, segmentQualified?, scheduledAt?, usePersonal? } - update_campaign [altera, pede confirmação]: Alterar campanha de WhatsApp. params: { id }, data: campos a mudar - send_campaign [envia, pede confirmação]: Disparar campanha de WhatsApp. params: { id } Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: status, messages, list_campaigns, campaign_recipients, audience, connect, disconnect, create_campaign, update_campaign, send_campaign | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "whatsapp_admin",
"arguments": {
"action": "status"
}
}
}Listas e contatos: listar, criar, renomear/arquivar, adicionar e tirar contatos, importar, exportar e enviar contatos para o funil. Ações: - list: Listar listas. params: { archived?: 1 } - get: Ver lista e contatos. params: { listId, page?, q? } - export: Exportar lista (CSV). params: { listId } - audience_options: Opções de audiência (forms, listas, etapas) - create [cria, pede confirmação]: Criar lista. data: { name, description?, legalBasis?: consentimento|legitimo_interesse } - update [altera, pede confirmação]: Alterar ou arquivar lista. params: { listId }, data: { name?, description?, legalBasis?, archived? } - add_member [cria, pede confirmação]: Adicionar contato à lista. params: { listId }, data: { leadIds? } ou { contact: { nome, email?, telefone?, empresa? } } - remove_members [exclui, pede confirmação]: Tirar contatos da lista. params: { listId }, data: { leadIds: [...] } - import [cria, pede confirmação]: Importar contatos para a lista. params: { listId }, data: { rows: [{ nome, email, telefone, empresa, ... }] } - send_to_funnel [altera, pede confirmação]: Enviar contatos para o funil. params: { listId }, data: { stageId, ownerId?, mode?: skip|move, leadIds? (sem = lista inteira) } Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: list, get, export, audience_options, create, update, add_member, remove_members, import, send_to_funnel | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "lists",
"arguments": {
"action": "list"
}
}
}Agenda e reuniões: configurações de agenda do usuário e da conta, horários livres, grade semanal, agendar reunião e desconectar Google/Outlook. Conectar a agenda é pela tela (login do Google/Microsoft). Ações: - get_settings: Configurações da minha agenda - get_scheduling: Configuração de agendamento da conta - slots: Horários livres. params: { leadId, ... } - week: Grade semanal (livres, ocupados, reuniões). params: { week?: YYYY-MM-DD, users?: id1,id2, leadId? } - update_settings [altera, pede confirmação]: Alterar minha agenda. data: { durationMin?, bufferMin?, workStart?, workEnd?, timezone?, calendarRole?, defaultGuests?, ignorePendingInvites? } - update_scheduling [altera, pede confirmação]: Alterar agendamento da conta. data: campos de get_scheduling - book [envia, pede confirmação]: Agendar reunião. data: { leadId, startISO, closerUserId?, meetingKind?: primeira|segunda|extra, guests?: [emails] } (use slots/week antes) - disconnect_google [exclui, pede confirmação]: Desconectar Google Agenda - disconnect_outlook [exclui, pede confirmação]: Desconectar Outlook Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: get_settings, get_scheduling, slots, week, update_settings, update_scheduling, book, disconnect_google, disconnect_outlook | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "agenda",
"arguments": {
"action": "get_settings"
}
}
}Propostas (PDF com rastreio de abertura): listar, ver, renomear, excluir e gerar o link de um lead. O PDF novo sobe pela tela. Ações: - list: Listar propostas - get: Ver proposta e aberturas. params: { id } - update [altera, pede confirmação]: Alterar proposta. params: { id }, data: { name?, pdfName? } - delete [exclui, pede confirmação]: Excluir proposta. params: { id } - link_for_lead [cria, pede confirmação]: Gerar link da proposta para um lead. params: { id }, data: { leadId } (não envia: devolve o link) Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: list, get, update, delete, link_for_lead | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "proposals",
"arguments": {
"action": "list"
}
}
}Prospecção outbound: resumo, saldo, estimativa de custo, buscas (criar, ver, alterar, exportar), leads encontrados e lista de exclusão (opt-out). Ações: - summary: Resumo da prospecção - wallet: Saldo - estimate: Estimar custo de uma busca. data: filtros da busca (ICP) - list_runs: Listar buscas - get_run: Ver busca. params: { id } - export_run: Exportar busca (CSV). params: { id } - leads: Leads encontrados. params: filtros da tela - optout_list: Lista de exclusão - create_run [envia, pede confirmação]: Criar busca de prospecção. data: ICP/filtros (rode estimate antes) - update_run [altera, pede confirmação]: Alterar busca. params: { id }, data: campos da tela - optout_add [cria, pede confirmação]: Adicionar à lista de exclusão. data: { type, value, reason? } - optout_remove [exclui, pede confirmação]: Tirar da lista de exclusão. data: { type, value } Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: summary, wallet, estimate, list_runs, get_run, export_run, leads, optout_list, create_run, update_run, optout_add, optout_remove | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "prospeccao",
"arguments": {
"action": "summary"
}
}
}Integrações dos formulários (RD Station CRM e Marketing, Pipedrive, Agendor, Ploomes, Leads2B, Google Sheets, webhook, Meta Lead Ads): listar, criar, alterar, excluir, testar, diagnosticar, logs, reenviar leads antigos e consultas de apoio (funis, campos, usuários). Ações: - list: Listar integrações - webhook_logs: Logs de envio. params: { integrationId, limit? } - diagnose: Diagnosticar integração. params: { integrationId } - test_connection: Testar credenciais. data: { type, config } - rd_crm_pipelines: RD CRM: funis e etapas. data: { token } ou { integrationId } - rd_crm_custom_fields: RD CRM: campos personalizados. data: { token } ou { integrationId } - rd_crm_users_teams: RD CRM: usuários e equipes. data: { token } ou { integrationId } - rd_marketing_fields: RD Marketing: campos. data: { integrationId } ou credenciais - pipedrive_pipelines: Pipedrive: funis. data: { token } ou { integrationId } - agendor_funnels: Agendor: funis. data: { token } ou { integrationId } - meta_status: Meta Lead Ads: status - meta_pages: Meta Lead Ads: páginas - meta_forms: Meta Lead Ads: formulários da página. params: { pageId } - google_status: Google Sheets: status - google_spreadsheets: Google Sheets: planilhas - google_sheets: Google Sheets: abas da planilha. params: { spreadsheetId } - create [cria, pede confirmação]: Criar integração. data: { type, name, config, fieldMap?, fireOn: formId|all, enabled? } - update [altera, pede confirmação]: Alterar integração. params: { integrationId }, data: { name?, enabled?, config?, fieldMap?, fireOn? } - delete [exclui, pede confirmação]: Excluir integração. params: { integrationId } - test_send [envia, pede confirmação]: Enviar lead de teste. data: { integrationId } ou { type, config, fieldMap } - backfill [envia, pede confirmação]: Reenviar leads antigos. params: { integrationId }, data: { since?, leadIds? } - meta_select_page [altera, pede confirmação]: Meta Lead Ads: escolher página. data: { pageId } - meta_activate [altera, pede confirmação]: Meta Lead Ads: ativar formulário. data: campos da tela (pageId, metaFormId...) - google_disconnect [exclui, pede confirmação]: Desconectar Google Sheets Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: list, webhook_logs, diagnose, test_connection, rd_crm_pipelines, rd_crm_custom_fields, rd_crm_users_teams, rd_marketing_fields, pipedrive_pipelines, agendor_funnels, meta_status, meta_pages, meta_forms, google_status, google_spreadsheets, google_sheets, create, update, delete, test_send, backfill, meta_select_page, meta_activate, google_disconnect | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "integrations",
"arguments": {
"action": "list"
}
}
}Números da conta: dashboard, anel de uso e histórico de alterações (auditoria). Ações: - dashboard: Dashboard. params: { formIds?, from?, to?, days?, compare?, allTime?, lmvOnly?, utmDim?, utmVal? } - usage: Anel de uso - audit_log: Histórico de alterações. params: { entityType?, entityId?, page? } Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: dashboard, usage, audit_log | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "reports",
"arguments": {
"action": "dashboard"
}
}
}Usuários da conta: listar membros e convites, convidar, mudar papel e remover. Ações: - list: Listar membros e convites - invite [envia, pede confirmação]: Convidar usuário. data: { email, role?: ADMIN|MEMBER } - change_role [altera, pede confirmação]: Mudar papel. params: { membershipId }, data: { role: ADMIN|MEMBER } - remove [exclui, pede confirmação]: Remover usuário ou cancelar convite. params: { membershipId } ou { inviteId } Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: list, invite, change_role, remove | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "users",
"arguments": {
"action": "list"
}
}
}Configurações: nome da empresa, perfil do usuário, LMV (simular, aplicar, reclassificar), notificações, preferências, ramal, desfazer alteração pelo histórico e reativar conta em exclusão. Fora, de propósito: chaves de API, cobrança, senha e excluir conta. Ações: - get_lmv: Ver regra de LMV - lmv_simulate: Simular regra de LMV. data: { rule: { criteria: [{ field, operator, value }], combinator: AND|OR } | null, mode?: off|empty|all } - lmv_apply [altera, pede confirmação]: Aplicar regra de LMV. data: { rule, mode? } - lmv_resync [altera, pede confirmação]: Reclassificar base com a LMV salva - get_notifications: Notificações da conta - update_notifications [altera, pede confirmação]: Alterar notificações da conta. data: campos de get_notifications - get_my_notifications: Minhas preferências de notificação - update_my_notifications [altera, pede confirmação]: Alterar minhas notificações. data: campos de get_my_notifications - get_preferences: Minhas preferências - update_preferences [altera, pede confirmação]: Alterar minhas preferências. data: campos de get_preferences - get_ramal: Meu ramal (telefonia) - update_ramal [altera, pede confirmação]: Alterar meu ramal. data: { ramal } - rename_company [altera, pede confirmação]: Alterar nome da empresa. data: { name } - update_profile [altera, pede confirmação]: Alterar meu perfil. data: { name?, phone?, ... } (sem senha) - revert_audit [altera, pede confirmação]: Desfazer alteração pelo histórico. params: { id } (id de reports.audit_log) - reactivate_account [altera, pede confirmação]: Cancelar exclusão agendada da conta - remark_form_lmv [altera, pede confirmação]: Recalcular LMV de um formulário. params: { formId } Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: get_lmv, lmv_simulate, lmv_apply, lmv_resync, get_notifications, update_notifications, get_my_notifications, update_my_notifications, get_preferences, update_preferences, get_ramal, update_ramal, rename_company, update_profile, revert_audit, reactivate_account, remark_form_lmv | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "settings",
"arguments": {
"action": "get_lmv"
}
}
}Agentes SDR de IA: listar, ver, criar, alterar (inclusive ativar/pausar), excluir, simular conversa, restaurar versão e ver conversas. Ações: - list: Listar agentes - get: Ver agente. params: { id } - conversation: Ver conversa do agente. params: { id, cid } - simulate: Simular conversa (não envia nada). params: { id }, data: { messages: [...] } - create [cria, pede confirmação]: Criar agente. data: { name } - update [altera, pede confirmação]: Alterar agente. params: { id }, data: { name?, status?: active|paused, config?, soul? } - restore [altera, pede confirmação]: Restaurar versão do agente. params: { id }, data: { version } - delete [exclui, pede confirmação]: Excluir agente. params: { id } Ações que criam, alteram, excluem ou enviam NÃO executam na 1ª chamada: devolvem a prévia com o impacto na operação e um confirmToken; a ação só executa numa nova chamada com esse confirmToken (mesmos argumentos). Mesmas regras e permissões da tela (papel do usuário asUserEmail; sem ele, o dono da conta).
Argumentos
| Nome | Tipo | Descrição |
|---|---|---|
| actionobrigatório | string: list, get, conversation, simulate, create, update, restore, delete | |
| params | object | Ids que vão na URL e filtros (ver ação). |
| data | object | Corpo da ação (ver ação). |
| asUserEmail | string | Membro da conta que executa (papel e autoria). Padrão: dono da conta. |
| confirmToken | string | Token devolvido pela prévia; vale só para os mesmos argumentos. |
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "ai_agents",
"arguments": {
"action": "list"
}
}
}Changelog
Revisado todo mês com base no que mudou no GorilaForms. Última revisão: 19/11/2026. Catálogo do MCP gerado do código em 20/11/2026.
- A ação prospeccao.create_order (comprar saldo de prospecção) saiu do MCP. Compra de saldo é feita só pela tela Saldo.
- As descrições das tools passaram a só descrever o comportamento: sem confirmToken a ação não executa e devolve a prévia; com ele, executa.
- Novas tools por área: crm_config, leads_admin, automations_admin, cadences_admin, templates_admin, email_admin, whatsapp_admin, lists, agenda, proposals, prospeccao, integrations, reports, users, settings e ai_agents. Cada uma recebe action, params, data e asUserEmail.
- As ações usam as mesmas rotas da tela: mesma validação, mesmo papel do usuário (asUserEmail; sem ele, o dono da conta) e mesma auditoria.
- Toda ação que cria, altera, exclui ou envia devolve primeiro uma prévia (status confirmacao_necessaria) com o que acontece na operação: leads afetados, automações e cadências que usam o registro, o que para e o que não volta. Só executa na 2ª chamada com o confirmToken, que vale 15 min e só para os mesmos argumentos e o mesmo estado do registro.
- As tools de escrita que já existiam (create_lead, update_lead, move_lead, envios, modelos, cadências, automações, campanhas, create_form e duplicate_form) passaram a pedir a mesma confirmação. update_lead com dryRun=true continua só simulando.
- Fora do MCP, de propósito: chaves de API, cobrança e plano, senha e exclusão da conta.
- O servidor MCP aceita login OAuth 2.1 (código de autorização com PKCE S256, registro dinâmico de cliente e Client ID Metadata Document). No Claude, basta adicionar o conector com a URL e entrar com o login do GorilaForms.
- O usuário escolhe a conta na tela de autorização e o app age com o papel dele nela. Token de acesso de 1 hora, renovação com rotação e desconexão em Configurações, API Keys.
- tools/list traz título e anotações (readOnlyHint, destructiveHint) em toda tool; initialize negocia a versão do protocolo e manda as instruções de uso.
- Novas tools get_form, create_form, duplicate_form, update_form e delete_form.
- Editar um formulário que já existe sempre mostra antes a prévia (o que muda, se está no ar, leads recentes e integrações) e só grava com confirm=true e a version da prévia. Se o formulário mudou depois da prévia, a gravação é recusada.
- duplicate_form pode trocar o tipo (padrão, chat ou botão de WhatsApp) e já configurar o Pixel na cópia.
- delete_form só exclui formulário sem leads. Com leads, a saída é tirar do ar (active=false).
- Novos endpoints /crm/webhooks: listar, cadastrar, detalhar, atualizar (pausar, trocar URL e eventos, rotacionar segredo), remover e testar.
- O cliente cadastra o próprio webhook com a chave de API, sem passar pelo suporte.
- Novo evento ping, enviado só pelo teste.
- Novas tools get_email_context, create_campaign, update_campaign, test_campaign, send_campaign e list_campaign_recipients. Testar e disparar exigem confirm=true.
- send_lead_email aceita templateId e anexos (até 10).
- create_template e update_template preservam o editor Visual e aceitam PDF (pdfUrl, pdfName).
- Email para lead só sai com o domínio de envio verificado. Sem isso a chamada falha com email_domain_blocked.
- Contas da Plataforma 2.0 liberadas pelo plano passam a ser reconhecidas pelo MCP.
- list_leads do MCP devolve só leads. Contatos de lista ficam de fora até virarem lead (form, Lead Ads, agenda ou envio para funil).
- Negócio sem etapa gravada sai na 1ª etapa do funil padrão.
- Spam rejeitado ou em revisão fica fora por padrão (use includeSpam=true para incluir).
- update_lead ganhou dryRun: mostra o que mudaria e quais automações disparariam, sem gravar.
- Acima de 20 mudanças de status por minuto na conta, o MCP exige confirmBulk=true.
- Novas tools para editar lead, status e motivo de perda, tarefas, email e WhatsApp pelo lead, modelos, cadências e automações.
- Novos endpoints /crm/pipelines, /crm/deals (incremental com cursor), /crm/users, /crm/fields, /crm/tasks e /crm/deals/events.
- Webhooks de saída deal.created, deal.stage_changed e deal.status_changed, assinados com HMAC SHA-256.
- Movimentos automáticos aparecem no histórico com source=auto.
- Tools do MCP equivalentes: list_pipelines, list_users, list_fields, list_deals, list_tasks e list_deal_events.
- Lançamento do servidor MCP (JSON-RPC sobre HTTP) e dos endpoints /crm/board e /whatsapp/send.
- Chaves de API (gf_live_) e endpoints de formulários: listar, criar, detalhar, atualizar, leads, métricas e embed.