# Agilize Docs para IA

Este arquivo é a versão compacta, canônica e legível por IA da documentação pública da Agilize.
Ele combina guias locais versionados, páginas geradas a partir do OpenAPI e links para a referência interativa.

Última geração: 2026-05-27T06:54:16.484Z

## Como usar na prática

- Para responder dúvidas de usuários finais, priorize as seções "Guias de produto" e "Detalhes dos guias".
- Para integrações, priorize "API Agilize", "Autenticação", "Endpoints por assunto" e o OpenAPI JSON.
- Para exemplos executáveis, use a página individual do endpoint ou a referência interativa com Scalar.
- Para testes via navegador, prefira o proxy server-side da documentação quando disponível; chamadas diretas podem depender de CORS.
- Nunca invente parâmetros, permissões, limites, status ou payloads. Se o dado não estiver neste arquivo, consulte o OpenAPI JSON.
- A autenticação técnica usa o header x-api-key, salvo indicação específica do endpoint.

## Links canônicos

- Documentação humana: https://agilize.app/docs
- Leitura para IA: https://agilize.app/docs/llms.txt
- Referência interativa da API: https://agilize.app/docs/desenvolvedores/referencia-api
- OpenAPI JSON atual: https://agilize.app/api/docs/openapi/agilize
- Fallback OpenAPI versionado: https://agilize.app/openapi/agilize-v1.json

## API Agilize

- Título: Agilize.app Omni Channel API
- Versão da API: 0.0.12
- Versão OpenAPI: 3.1.0
- Base URL: https://api.agilize.app
- Autenticação principal: header x-api-key
- Total de endpoints mapeados: 95

### Cabeçalhos básicos

```http
Accept: application/json
x-api-key: SUA_CHAVE_API
```

## Índice de guias

- https://agilize.app/docs: Documentação Agilize - Guias oficiais para usuários, operadores e desenvolvedores que trabalham com a plataforma Agilize.
- https://agilize.app/docs/primeiros-passos: Primeiros passos - Visão inicial da plataforma e dos conceitos usados nos guias.
- https://agilize.app/docs/primeiros-passos/visao-geral: Visão geral - Entenda a lógica central da Agilize antes de configurar atendimento, CRM ou integrações.
- https://agilize.app/docs/usuarios: Usuários - Guias de uso para atendimento, CRM, oportunidades e operação diária.
- https://agilize.app/docs/usuarios/atendimento-omnichannel: Atendimento omnichannel - Como pensar a operação de atendimento com múltiplos canais, histórico e responsáveis.
- https://agilize.app/docs/usuarios/crm-e-oportunidades: CRM e oportunidades - Como organizar leads, etapas, responsáveis e próximas ações no CRM.
- https://agilize.app/docs/usuarios/automacoes-e-ia: Automações e IA - Como usar automações e IA como apoio operacional, com governança e supervisão.
- https://agilize.app/docs/desenvolvedores: Desenvolvedores - Guias técnicos para autenticação, webhooks e integração com a API Agilize.
- https://agilize.app/docs/desenvolvedores/introducao: Introdução à API - Visão geral para integrar sistemas externos à API Agilize.
- https://agilize.app/docs/desenvolvedores/autenticacao: Autenticação - Como autenticar chamadas na API Agilize usando chave de acesso.
- https://agilize.app/docs/desenvolvedores/referencia-api: Referência da API - Documentação interativa dos endpoints da API Agilize, carregada a partir do Swagger oficial com fallback local.
- https://agilize.app/docs/desenvolvedores/webhooks: Webhooks - Como preparar um endpoint para receber eventos enviados pela Agilize.
- https://agilize.app/docs/desenvolvedores/api: Endpoints da API - Páginas individuais dos métodos da API Agilize, geradas a partir do OpenAPI oficial versionado.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-lead: CRM - Lead - Eventos de webhook da Agilize para CRM - Lead.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/funil: Funil - Webhooks da Agilize para Funil em CRM - Lead.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/funil/post-crm-lead-funnel-create: Funil - Criação - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/funil/post-crm-lead-funnel-patch: Funil - Atualização - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/funil/post-crm-lead-funnel-remove: Funil - Exclusão - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/oportunidade: Oportunidade - Webhooks da Agilize para Oportunidade em CRM - Lead.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/oportunidade/post-crm-lead-lead-create: Oportunidade - Criação - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/oportunidade/post-crm-lead-lead-patch: Oportunidade - Atualização - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/oportunidade/post-crm-lead-lead-remove: Oportunidade - Exclusão - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/origem-de-oportunidade: Origem de oportunidade - Webhooks da Agilize para Origem de oportunidade em CRM - Lead.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/origem-de-oportunidade/post-crm-lead-source-create: Origem de oportunidade - Criação - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/origem-de-oportunidade/post-crm-lead-source-patch: Origem de oportunidade - Atualização - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/origem-de-oportunidade/post-crm-lead-source-remove: Origem de oportunidade - Exclusão - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-support: CRM - Support - Eventos de webhook da Agilize para CRM - Support.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-support/suporte: Suporte - Webhooks da Agilize para Suporte em CRM - Support.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-support/suporte/post-crm-support-support-create: Suporte - Criação - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-support/suporte/post-crm-support-support-patch: Suporte - Atualização - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/crm-support/suporte/post-crm-support-support-remove: Suporte - Exclusão - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/file-upload: File - Upload - Eventos de webhook da Agilize para File - Upload.
- https://agilize.app/docs/desenvolvedores/webhooks/file-upload/documento: Documento - Webhooks da Agilize para Documento em File - Upload.
- https://agilize.app/docs/desenvolvedores/webhooks/file-upload/documento/post-file-upload-create: Documento - Criação - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/file-upload/documento/post-file-upload-patch: Documento - Atualização - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/file-upload/documento/post-file-upload-remove: Documento - Exclusão - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/messenger-chat: Messenger - Chat - Eventos de webhook da Agilize para Messenger - Chat.
- https://agilize.app/docs/desenvolvedores/webhooks/messenger-chat/sala-de-conversa: Sala de Conversa - Webhooks da Agilize para Sala de Conversa em Messenger - Chat.
- https://agilize.app/docs/desenvolvedores/webhooks/messenger-chat/sala-de-conversa/post-messenger-chat-room-create: Sala de Conversa - Criação - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/messenger-chat/sala-de-conversa/post-messenger-chat-room-patch: Sala de Conversa - Atualização - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/messenger-chat/sala-de-conversa/post-messenger-chat-room-remove: Sala de Conversa - Exclusão - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/messenger-chatbot: Messenger - Chatbot - Eventos de webhook da Agilize para Messenger - Chatbot.
- https://agilize.app/docs/desenvolvedores/webhooks/messenger-chatbot/chatbot: Chatbot - Webhooks da Agilize para Chatbot em Messenger - Chatbot.
- https://agilize.app/docs/desenvolvedores/webhooks/messenger-chatbot/chatbot/post-messenger-chatbot-nodehttpdelegate: Controle Fluxo de Chatbot - Metodo HTTP que aceita um POST para processamento de mensagens. Retorno de um JSON contendo mensagens, controle do fluxo, e variáveis. Tempo limite para geração do conteúdo de até 5 minutos.
- https://agilize.app/docs/desenvolvedores/webhooks/messenger-chatbot/chatbot/post-messenger-chatbot-nodehttpwebhook: Webhook HTTP (Saída) do Chatbot - Estrutura enviada pelo node NodeHttpWebhook para a URL configurada no fluxo. Este endpoint deve ser implementado pelo cliente/terceiro para receber os dados e reagir conforme necessário.
- https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx: Voice - PBX - Eventos de webhook da Agilize para Voice - PBX.
- https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx/call: Call - Webhooks da Agilize para Call em Voice - PBX.
- https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx/call/post-voice-pbx-call-link: Call - Vinculação - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx/call/post-voice-pbx-call-unlink: Call - Desvinculação - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx/channel: Channel - Webhooks da Agilize para Channel em Voice - PBX.
- https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx/channel/post-voice-pbx-channel-dial: Channel - Discagem - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
- https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx/channel/post-voice-pbx-channel-hangup: Channel - Encerramento - Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.

## Detalhes dos guias

### Documentação Agilize
- URL: https://agilize.app/docs
- Resumo: Guias oficiais para usuários, operadores e desenvolvedores que trabalham com a plataforma Agilize.
  - Seções: Comece pelo seu objetivo | Padrão da documentação
- Conteúdo útil: Documentação Agilize Use esta central para entender a operação no produto, configurar fluxos com segurança e integrar sistemas externos à API Agilize. Comece pelo seu objetivo - Usuários e operação: consulte os guias de atendimento, CRM, oportunidades, automações e rotina operacional. - Desenvolvedores: use os guias técnicos para autenticação, webhooks e referência da API. - Gestores: acompanhe os conceitos de origem, etapa, responsável, tarefas e qualidade de lead antes de tomar decisões de operação. Padrão da documentação Os artigos são organizados por tarefas reais. Cada guia deve deixar claro quando usar, quais pré-condições existem, quais passos executar e o que verificar depois.

### Primeiros passos
- URL: https://agilize.app/docs/primeiros-passos
- Resumo: Visão inicial da plataforma e dos conceitos usados nos guias.
- Conteúdo útil: Primeiros passos Comece por aqui para entender como a Agilize conecta canais, contatos, oportunidades, automações e indicadores.

### Visão geral
- URL: https://agilize.app/docs/primeiros-passos/visao-geral
- Resumo: Entenda a lógica central da Agilize antes de configurar atendimento, CRM ou integrações.
  - Seções: Conceitos principais | Próximos passos
- Conteúdo útil: Visão geral A Agilize organiza conversas, leads e tarefas em uma rotina operacional acompanhável. O objetivo é conectar canais de atendimento, CRM, automações e indicadores para que cada contato tenha histórico, responsável, etapa e próxima ação. Conceitos principais - Canal: origem operacional da conversa, como WhatsApp, livechat, SMS ou telefonia. - Contato: pessoa ou empresa atendida pela operação. - Oportunidade: registro comercial que acompanha etapa, origem, responsável e qualidade. - Tarefa: próxima ação esperada para manter o atendimento ou venda em movimento. - Automação: regra ou fluxo que ajuda a classificar, encaminhar, avisar ou executar ações repetitivas. Próximos passos Depoi...

### Usuários
- URL: https://agilize.app/docs/usuarios
- Resumo: Guias de uso para atendimento, CRM, oportunidades e operação diária.
- Conteúdo útil: Usuários Esta seção reúne guias para quem usa a Agilize na rotina de atendimento, vendas, suporte e gestão operacional.

### Atendimento omnichannel
- URL: https://agilize.app/docs/usuarios/atendimento-omnichannel
- Resumo: Como pensar a operação de atendimento com múltiplos canais, histórico e responsáveis.
  - Seções: Quando usar | Boas práticas
- Conteúdo útil: Atendimento omnichannel O atendimento omnichannel centraliza interações de diferentes canais para reduzir perda de histórico e facilitar a continuidade da conversa. Quando usar Use este guia quando a operação precisar organizar conversas por responsável, acompanhar retornos ou manter contexto entre canais. Boas práticas - Mantenha responsável definido para cada contato em atendimento. - Registre a próxima ação quando a conversa depender de retorno. - Use a timeline para entender o que já aconteceu antes de responder.

### CRM e oportunidades
- URL: https://agilize.app/docs/usuarios/crm-e-oportunidades
- Resumo: Como organizar leads, etapas, responsáveis e próximas ações no CRM.
  - Seções: O que acompanhar | Resultado esperado
- Conteúdo útil: CRM e oportunidades O CRM transforma contatos e conversas em oportunidades acompanháveis. Cada oportunidade deve ter contexto suficiente para que o time saiba origem, etapa, responsável e próximo passo. O que acompanhar - Origem do lead ou campanha. - Etapa atual do funil. - Responsável pela oportunidade. - Tarefas e retornos pendentes. - Histórico de interações. Resultado esperado A gestão deve conseguir diferenciar volume de cadastro de qualidade comercial real.

### Automações e IA
- URL: https://agilize.app/docs/usuarios/automacoes-e-ia
- Resumo: Como usar automações e IA como apoio operacional, com governança e supervisão.
  - Seções: Princípios | Exemplos de uso
- Conteúdo útil: Automações e IA Automações e IA devem apoiar tarefas concretas da operação: triagem, follow-up, classificação, encaminhamento, geração de tarefas e organização do contexto. Princípios - Automatize rotinas repetitivas, não decisões sensíveis sem supervisão. - Mantenha fallback humano quando houver incerteza. - Documente gatilhos, condições e efeitos esperados de cada fluxo. Exemplos de uso - Criar tarefa quando um lead fica sem retorno. - Classificar intenção inicial de uma conversa. - Enviar alerta quando uma oportunidade muda de etapa.

### Desenvolvedores
- URL: https://agilize.app/docs/desenvolvedores
- Resumo: Guias técnicos para autenticação, webhooks e integração com a API Agilize.
  - Seções: Guias disponíveis
- Conteúdo útil: Desenvolvedores Esta seção reúne o conteúdo técnico para integrar sistemas externos à Agilize. Guias disponíveis - Introdução à API. - Autenticação com chave de acesso. - Páginas individuais dos endpoints da API. - Configuração e tratamento de webhooks. - Referência interativa da API.

### Introdução à API
- URL: https://agilize.app/docs/desenvolvedores/introducao
- Resumo: Visão geral para integrar sistemas externos à API Agilize.
  - Seções: Antes de começar | URL base
- Conteúdo útil: Introdução à API A API Agilize permite integrar sistemas externos à operação omnichannel, CRM, canais de atendimento e rotinas de automação. Antes de começar - Defina qual processo será integrado. - Confirme quais dados precisam trafegar entre os sistemas. - Gere uma chave de acesso no ambiente autorizado. - Teste primeiro em uma operação controlada. URL base http https://api.agilize.app/ Use a referência da API para consultar endpoints, parâmetros e formatos de resposta.

### Autenticação
- URL: https://agilize.app/docs/desenvolvedores/autenticacao
- Resumo: Como autenticar chamadas na API Agilize usando chave de acesso.
  - Seções: Cabeçalhos principais | Exemplo | Segurança
- Conteúdo útil: Autenticação As requisições para a API devem incluir a chave de acesso no cabeçalho da chamada. Cabeçalhos principais http Accept: application/json x-api-key: SUACHAVEAPI Exemplo bash curl --request GET \ --url "https://api.agilize.app/" \ --header "Accept: application/json" \ --header "x-api-key: SUACHAVEAPI" Segurança Nunca exponha a chave de acesso em código público, documentação pública, logs abertos ou aplicações client-side.

### Referência da API
- URL: https://agilize.app/docs/desenvolvedores/referencia-api
- Resumo: Documentação interativa dos endpoints da API Agilize, carregada a partir do Swagger oficial com fallback local.
  - Seções: Base da API | Exemplos rápidos | Testar e gerar código
- Conteúdo útil: Referência da API A referência abaixo carrega o Swagger oficial da Agilize. Se o arquivo remoto estiver indisponível, o portal usa a última versão local versionada no projeto. Ela segue o padrão esperado para documentação técnica: busca por endpoints, detalhes de parâmetros e respostas, botão de teste de requisição, download do documento OpenAPI e geração de código básico por linguagem. Base da API text https://api.agilize.app As chamadas autenticadas usam a chave de API no cabeçalho: http Accept: application/json x-api-key: SUACHAVEAPI Exemplos rápidos Os exemplos abaixo usam a listagem de oportunidades como ponto de partida. Para outros recursos, selecione o endpoint correspondente na ref...

### Webhooks
- URL: https://agilize.app/docs/desenvolvedores/webhooks
- Resumo: Como preparar um endpoint para receber eventos enviados pela Agilize.
  - Seções: Antes de configurar | Eventos disponíveis | Boas práticas
- Conteúdo útil: Webhooks Webhooks permitem que um sistema externo receba eventos da Agilize sem precisar consultar a API continuamente. Antes de configurar - Crie uma URL pública HTTPS para receber eventos. - Garanta que o endpoint responda rapidamente. - Registre logs suficientes para investigar falhas. - Valide o formato do payload antes de processar regras de negócio. Eventos disponíveis A lista abaixo é carregada automaticamente a partir do Swagger oficial da Agilize. Quando a API oficial não estiver disponível, a documentação usa a última versão local de fallback. ::OpenApiWebhooks{specUrl="/api/docs/openapi/agilize"} :: Boas práticas - Responda com status de sucesso apenas depois de receber o evento...

### Endpoints da API
- URL: https://agilize.app/docs/desenvolvedores/api
- Resumo: Páginas individuais dos métodos da API Agilize, geradas a partir do OpenAPI oficial versionado.
  - Seções: Assuntos | Testes interativos
- Conteúdo útil: Esta seção organiza os métodos da API por assunto. Cada página mostra URL, autenticação, parâmetros, corpo de requisição, respostas, exemplos básicos e link para testar o endpoint na referência interativa. As páginas desta seção são geradas a partir do OpenAPI local em public/openapi/agilize-v1.json. Elas são recriadas automaticamente antes de npm run dev, npm run build e npm run generate. Para atualizar manualmente sem iniciar o projeto, rode: bash npm run docs:openapi Assuntos - File - Upload - 7 métodos - Messenger - Chat - 11 métodos - Voice - PBX - 2 métodos - CRM - Timeline - 5 métodos - CRM - Lead - 25 métodos - CRM - Support - 10 métodos - CRM - Contact - 5 métodos - CRM - Company -...

### CRM - Lead
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-lead
- Resumo: Eventos de webhook da Agilize para CRM - Lead.
  - Seções: Página principal
- Conteúdo útil: Eventos disponíveis para este assunto. Cada serviço agrupa webhooks do mesmo recurso para manter a navegação objetiva. | Serviço | Eventos | Principais eventos | | --- | --- | --- | | Oportunidade | 3 | Oportunidade - Criação, Oportunidade - Atualização, Oportunidade - Exclusão | | Funil | 3 | Funil - Criação, Funil - Atualização, Funil - Exclusão | | Origem de oportunidade | 3 | Origem de oportunidade - Criação, Origem de oportunidade - Atualização, Origem de oportunidade - Exclusão | Página principal Volte para a visão geral de webhooks para consultar a lista completa carregada diretamente do Swagger.

### Funil
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/funil
- Resumo: Webhooks da Agilize para Funil em CRM - Lead.
- Conteúdo útil: Eventos disponíveis para este serviço. | Método | Evento | Chave no Swagger | Descrição | | --- | --- | --- | --- | | POST | Funil - Criação | crm/lead/funnel/create | Funil - Criação | | POST | Funil - Atualização | crm/lead/funnel/patch | Funil - Atualização | | POST | Funil - Exclusão | crm/lead/funnel/remove | Funil - Exclusão |

### Funil - Criação
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/funil/post-crm-lead-funnel-create
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST crm/lead/funnel/create Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | name | string | Não | | | | stages | object[] | Não | | | | deleted | boolean | Não | | | | validatePreviousStageRequirements | boolean | Não | | | | allowArchiveWithoutRequiredFields | boolean | Não | | | | disableDefaultWonLossStages | boolean | Não | | | | hideWonKanban | boolean | Não | | | | hideArchivedKanban | boolean | Não | | | Exemplo básico recebido: json { "name": "va...

### Funil - Atualização
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/funil/post-crm-lead-funnel-patch
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST crm/lead/funnel/patch Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | name | string | Não | | | | stages | object[] | Não | | | | deleted | boolean | Não | | | | validatePreviousStageRequirements | boolean | Não | | | | allowArchiveWithoutRequiredFields | boolean | Não | | | | disableDefaultWonLossStages | boolean | Não | | | | hideWonKanban | boolean | Não | | | | hideArchivedKanban | boolean | Não | | | Exemplo básico recebido: json { "name": "val...

### Funil - Exclusão
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/funil/post-crm-lead-funnel-remove
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST crm/lead/funnel/remove Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | id | string | Não | | Identificador do registro excluído | Exemplo básico recebido: json { "id": "valor" } Respostas | Status | Descrição | Conteúdo | | --- | --- | --- | | 200 | Return a 200 status to indicate that the data was received successfully | | Boas práticas - Trate reenvios como possibilidade real. - Valide o payload antes de executar regras de negócio. - Registre o id...

### Oportunidade
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/oportunidade
- Resumo: Webhooks da Agilize para Oportunidade em CRM - Lead.
- Conteúdo útil: Eventos disponíveis para este serviço. | Método | Evento | Chave no Swagger | Descrição | | --- | --- | --- | --- | | POST | Oportunidade - Criação | crm/lead/lead/create | Oportunidade - Criação | | POST | Oportunidade - Atualização | crm/lead/lead/patch | Oportunidade - Atualização | | POST | Oportunidade - Exclusão | crm/lead/lead/remove | Oportunidade - Exclusão |

### Oportunidade - Criação
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/oportunidade/post-crm-lead-lead-create
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST crm/lead/lead/create Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | contacts | string[] | Não | | | | automations | string[] | Não | | | | companies | string[] | Não | | | | phones | object[] | Não | | | | emails | object[] | Não | | | | socials | object[] | Não | | | | name | string | Não | | Nome descritivo | | user | string | Não | | | | createdBy | string | Não | | | | import | string | Não | | Id da importação, caso tenha sido importado | | no...

### Oportunidade - Atualização
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/oportunidade/post-crm-lead-lead-patch
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST crm/lead/lead/patch Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | contacts | string[] | Não | | | | automations | string[] | Não | | | | companies | string[] | Não | | | | phones | object[] | Não | | | | emails | object[] | Não | | | | socials | object[] | Não | | | | name | string | Não | | Nome descritivo | | user | string | Não | | | | createdBy | string | Não | | | | import | string | Não | | Id da importação, caso tenha sido importado | | not...

### Oportunidade - Exclusão
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/oportunidade/post-crm-lead-lead-remove
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST crm/lead/lead/remove Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | id | string | Não | | Identificador do registro excluído | Exemplo básico recebido: json { "id": "valor" } Respostas | Status | Descrição | Conteúdo | | --- | --- | --- | | 200 | Return a 200 status to indicate that the data was received successfully | | Boas práticas - Trate reenvios como possibilidade real. - Valide o payload antes de executar regras de negócio. - Registre o iden...

### Origem de oportunidade
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/origem-de-oportunidade
- Resumo: Webhooks da Agilize para Origem de oportunidade em CRM - Lead.
- Conteúdo útil: Eventos disponíveis para este serviço. | Método | Evento | Chave no Swagger | Descrição | | --- | --- | --- | --- | | POST | Origem de oportunidade - Criação | crm/lead/source/create | Origem de oportunidade - Criação | | POST | Origem de oportunidade - Atualização | crm/lead/source/patch | Origem de oportunidade - Atualização | | POST | Origem de oportunidade - Exclusão | crm/lead/source/remove | Origem de oportunidade - Exclusão |

### Origem de oportunidade - Criação
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/origem-de-oportunidade/post-crm-lead-source-create
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST crm/lead/source/create Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | name | string | Não | | | | color | string | Não | | | Exemplo básico recebido: json { "name": "valor", "color": "valor" } Respostas | Status | Descrição | Conteúdo | | --- | --- | --- | | 200 | Return a 200 status to indicate that the data was received successfully | | Boas práticas - Trate reenvios como possibilidade real. - Valide o payload antes de executar regras de negócio....

### Origem de oportunidade - Atualização
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/origem-de-oportunidade/post-crm-lead-source-patch
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST crm/lead/source/patch Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | name | string | Não | | | | color | string | Não | | | Exemplo básico recebido: json { "name": "valor", "color": "valor" } Respostas | Status | Descrição | Conteúdo | | --- | --- | --- | | 200 | Return a 200 status to indicate that the data was received successfully | | Boas práticas - Trate reenvios como possibilidade real. - Valide o payload antes de executar regras de negócio....

### Origem de oportunidade - Exclusão
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-lead/origem-de-oportunidade/post-crm-lead-source-remove
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST crm/lead/source/remove Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | id | string | Não | | Identificador do registro excluído | Exemplo básico recebido: json { "id": "valor" } Respostas | Status | Descrição | Conteúdo | | --- | --- | --- | | 200 | Return a 200 status to indicate that the data was received successfully | | Boas práticas - Trate reenvios como possibilidade real. - Valide o payload antes de executar regras de negócio. - Registre o id...

### CRM - Support
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-support
- Resumo: Eventos de webhook da Agilize para CRM - Support.
  - Seções: Página principal
- Conteúdo útil: Eventos disponíveis para este assunto. Cada serviço agrupa webhooks do mesmo recurso para manter a navegação objetiva. | Serviço | Eventos | Principais eventos | | --- | --- | --- | | Suporte | 3 | Suporte - Criação, Suporte - Atualização, Suporte - Exclusão | Página principal Volte para a visão geral de webhooks para consultar a lista completa carregada diretamente do Swagger.

### Suporte
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-support/suporte
- Resumo: Webhooks da Agilize para Suporte em CRM - Support.
- Conteúdo útil: Eventos disponíveis para este serviço. | Método | Evento | Chave no Swagger | Descrição | | --- | --- | --- | --- | | POST | Suporte - Criação | crm/support/support/create | Suporte - Criação | | POST | Suporte - Atualização | crm/support/support/patch | Suporte - Atualização | | POST | Suporte - Exclusão | crm/support/support/remove | Suporte - Exclusão |

### Suporte - Criação
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-support/suporte/post-crm-support-support-create
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST crm/support/support/create Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | customer | string | Não | Exemplo: 664f5ab2c3d4e5f678901234 | Cliente do CRM associado ao ticket quando a operacao usar vinculo formal de customer. | | room | string | Não | Exemplo: 664f5ab2c3d4e5f678901235 | Sala de conversa de origem do ticket. Usada para vinculo operacional com o Messenger. | | contact | string | Não | Exemplo: 664f5ab2c3d4e5f678901236 | Contato principal...

### Suporte - Atualização
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-support/suporte/post-crm-support-support-patch
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST crm/support/support/patch Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | customer | string | Não | Exemplo: 664f5ab2c3d4e5f678901234 | Cliente do CRM associado ao ticket quando a operacao usar vinculo formal de customer. | | room | string | Não | Exemplo: 664f5ab2c3d4e5f678901235 | Sala de conversa de origem do ticket. Usada para vinculo operacional com o Messenger. | | contact | string | Não | Exemplo: 664f5ab2c3d4e5f678901236 | Contato principal...

### Suporte - Exclusão
- URL: https://agilize.app/docs/desenvolvedores/webhooks/crm-support/suporte/post-crm-support-support-remove
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST crm/support/support/remove Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | id | string | Não | | Identificador do registro excluído | Exemplo básico recebido: json { "id": "valor" } Respostas | Status | Descrição | Conteúdo | | --- | --- | --- | | 200 | Return a 200 status to indicate that the data was received successfully | | Boas práticas - Trate reenvios como possibilidade real. - Valide o payload antes de executar regras de negócio. - Registre...

### File - Upload
- URL: https://agilize.app/docs/desenvolvedores/webhooks/file-upload
- Resumo: Eventos de webhook da Agilize para File - Upload.
  - Seções: Página principal
- Conteúdo útil: Eventos disponíveis para este assunto. Cada serviço agrupa webhooks do mesmo recurso para manter a navegação objetiva. | Serviço | Eventos | Principais eventos | | --- | --- | --- | | Documento | 3 | Documento - Criação, Documento - Atualização, Documento - Exclusão | Página principal Volte para a visão geral de webhooks para consultar a lista completa carregada diretamente do Swagger.

### Documento
- URL: https://agilize.app/docs/desenvolvedores/webhooks/file-upload/documento
- Resumo: Webhooks da Agilize para Documento em File - Upload.
- Conteúdo útil: Eventos disponíveis para este serviço. | Método | Evento | Chave no Swagger | Descrição | | --- | --- | --- | --- | | POST | Documento - Criação | file/upload/create | Documento - Criação | | POST | Documento - Atualização | file/upload/patch | Documento - Atualização | | POST | Documento - Exclusão | file/upload/remove | Documento - Exclusão |

### Documento - Criação
- URL: https://agilize.app/docs/desenvolvedores/webhooks/file-upload/documento/post-file-upload-create
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST file/upload/create Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | mimetype | string | Não | | | | name | string | Não | | | | size | number | Não | | | | category | string | Não | | | | md5 | string | Não | | | | isTemp | boolean | Não | | | | canDelete | boolean | Não | | | | canDeleteLocal | boolean | Não | | | | extStorage | boolean | Não | | | | contact | string | Não | | | | lead | string | Não | | | | storage | string | Não | | | Exemplo bási...

### Documento - Atualização
- URL: https://agilize.app/docs/desenvolvedores/webhooks/file-upload/documento/post-file-upload-patch
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST file/upload/patch Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | mimetype | string | Não | | | | name | string | Não | | | | size | number | Não | | | | category | string | Não | | | | md5 | string | Não | | | | isTemp | boolean | Não | | | | canDelete | boolean | Não | | | | canDeleteLocal | boolean | Não | | | | extStorage | boolean | Não | | | | contact | string | Não | | | | lead | string | Não | | | | storage | string | Não | | | Exemplo básic...

### Documento - Exclusão
- URL: https://agilize.app/docs/desenvolvedores/webhooks/file-upload/documento/post-file-upload-remove
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST file/upload/remove Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | id | string | Não | | Identificador do registro excluído | Exemplo básico recebido: json { "id": "valor" } Respostas | Status | Descrição | Conteúdo | | --- | --- | --- | | 200 | Return a 200 status to indicate that the data was received successfully | | Boas práticas - Trate reenvios como possibilidade real. - Valide o payload antes de executar regras de negócio. - Registre o identi...

### Messenger - Chat
- URL: https://agilize.app/docs/desenvolvedores/webhooks/messenger-chat
- Resumo: Eventos de webhook da Agilize para Messenger - Chat.
  - Seções: Página principal
- Conteúdo útil: Eventos disponíveis para este assunto. Cada serviço agrupa webhooks do mesmo recurso para manter a navegação objetiva. | Serviço | Eventos | Principais eventos | | --- | --- | --- | | Sala de Conversa | 3 | Sala de Conversa - Criação, Sala de Conversa - Atualização, Sala de Conversa - Exclusão | Página principal Volte para a visão geral de webhooks para consultar a lista completa carregada diretamente do Swagger.

### Sala de Conversa
- URL: https://agilize.app/docs/desenvolvedores/webhooks/messenger-chat/sala-de-conversa
- Resumo: Webhooks da Agilize para Sala de Conversa em Messenger - Chat.
- Conteúdo útil: Eventos disponíveis para este serviço. | Método | Evento | Chave no Swagger | Descrição | | --- | --- | --- | --- | | POST | Sala de Conversa - Criação | messenger/chat/room/create | Sala de Conversa - Criação | | POST | Sala de Conversa - Atualização | messenger/chat/room/patch | Sala de Conversa - Atualização | | POST | Sala de Conversa - Exclusão | messenger/chat/room/remove | Sala de Conversa - Exclusão |

### Sala de Conversa - Criação
- URL: https://agilize.app/docs/desenvolvedores/webhooks/messenger-chat/sala-de-conversa/post-messenger-chat-room-create
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST messenger/chat/room/create Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | guest | string | Não | | | | users | string[] | Não | | | | prefUser | string | Não | | | | owner | string | Não | | | | prefUserPendAttr | boolean | Não | | | | histUsers | string[] | Não | | | | tags | string[] | Não | | | | conversationDetailTags | string[] | Não | | | | department | string | Não | | Departamento atual da sala | | contact | string | Não | | | | tl | string...

### Sala de Conversa - Atualização
- URL: https://agilize.app/docs/desenvolvedores/webhooks/messenger-chat/sala-de-conversa/post-messenger-chat-room-patch
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST messenger/chat/room/patch Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | guest | string | Não | | | | users | string[] | Não | | | | prefUser | string | Não | | | | owner | string | Não | | | | prefUserPendAttr | boolean | Não | | | | histUsers | string[] | Não | | | | tags | string[] | Não | | | | conversationDetailTags | string[] | Não | | | | department | string | Não | | Departamento atual da sala | | contact | string | Não | | | | tl | string...

### Sala de Conversa - Exclusão
- URL: https://agilize.app/docs/desenvolvedores/webhooks/messenger-chat/sala-de-conversa/post-messenger-chat-room-remove
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST messenger/chat/room/remove Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | id | string | Não | | Identificador do registro excluído | Exemplo básico recebido: json { "id": "valor" } Respostas | Status | Descrição | Conteúdo | | --- | --- | --- | | 200 | Return a 200 status to indicate that the data was received successfully | | Boas práticas - Trate reenvios como possibilidade real. - Valide o payload antes de executar regras de negócio. - Registre...

### Messenger - Chatbot
- URL: https://agilize.app/docs/desenvolvedores/webhooks/messenger-chatbot
- Resumo: Eventos de webhook da Agilize para Messenger - Chatbot.
  - Seções: Página principal
- Conteúdo útil: Eventos disponíveis para este assunto. Cada serviço agrupa webhooks do mesmo recurso para manter a navegação objetiva. | Serviço | Eventos | Principais eventos | | --- | --- | --- | | Chatbot | 2 | Controle Fluxo de Chatbot, Webhook HTTP (Saída) do Chatbot | Página principal Volte para a visão geral de webhooks para consultar a lista completa carregada diretamente do Swagger.

### Chatbot
- URL: https://agilize.app/docs/desenvolvedores/webhooks/messenger-chatbot/chatbot
- Resumo: Webhooks da Agilize para Chatbot em Messenger - Chatbot.
- Conteúdo útil: Eventos disponíveis para este serviço. | Método | Evento | Chave no Swagger | Descrição | | --- | --- | --- | --- | | POST | Controle Fluxo de Chatbot | messenger/chatbot/NodeHttpDelegate | Metodo HTTP que aceita um POST para processamento de mensagens. Retorno de um JSON contendo mensagens, controle do fluxo, e variáveis. Tempo limite para geração do conteúdo de até 5 minutos. | | POST | Webhook HTTP (Saída) do Chatbot | messenger/chatbot/NodeHttpWebhook | Estrutura enviada pelo node NodeHttpWebhook para a URL configurada no fluxo. Este endpoint deve ser implementado pelo cliente/terceiro para receber os dados e reagir conforme necessário. |

### Controle Fluxo de Chatbot
- URL: https://agilize.app/docs/desenvolvedores/webhooks/messenger-chatbot/chatbot/post-messenger-chatbot-nodehttpdelegate
- Resumo: Metodo HTTP que aceita um POST para processamento de mensagens. Retorno de um JSON contendo mensagens, controle do fluxo, e variáveis. Tempo limite para geração do conteúdo de até 5 minutos.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST messenger/chatbot/NodeHttpDelegate Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | seq | integer | Sim | | Sequência da mensagem no fluxo atual | | vars | object | Sim | | | | interactiveReply | string | Não | | Resposta interativa do usuário | Estruturas internas vars json { "room": "object", "SAMPLEVAR": "string" } Exemplo básico recebido: json { "seq": 1, "vars": { "room": {}, "SAMPLEVAR": "valor" } } Respostas | Status | Descrição | Conteúdo | |...

### Webhook HTTP (Saída) do Chatbot
- URL: https://agilize.app/docs/desenvolvedores/webhooks/messenger-chatbot/chatbot/post-messenger-chatbot-nodehttpwebhook
- Resumo: Estrutura enviada pelo node NodeHttpWebhook para a URL configurada no fluxo. Este endpoint deve ser implementado pelo cliente/terceiro para receber os dados e reagir conforme necessário.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST messenger/chatbot/NodeHttpWebhook Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | roomId | string | Sim | | ID da sala (room) no banco | | chId | string | Sim | | Identificador do canal. No WhatsApp (chSrc=1) é o número do cliente. | | chSrc | integer | Sim | | Canal de origem (1=WhatsApp, 2=Facebook, 3=Instagram, 4=SMS) | | message | string,null | Não | | Texto da mensagem atual (quando houver) | | interactiveReply | string,null | Não | | Resposta...

### Voice - PBX
- URL: https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx
- Resumo: Eventos de webhook da Agilize para Voice - PBX.
  - Seções: Página principal
- Conteúdo útil: Eventos disponíveis para este assunto. Cada serviço agrupa webhooks do mesmo recurso para manter a navegação objetiva. | Serviço | Eventos | Principais eventos | | --- | --- | --- | | Channel | 2 | Channel - Discagem, Channel - Encerramento | | Call | 2 | Call - Vinculação, Call - Desvinculação | Página principal Volte para a visão geral de webhooks para consultar a lista completa carregada diretamente do Swagger.

### Call
- URL: https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx/call
- Resumo: Webhooks da Agilize para Call em Voice - PBX.
- Conteúdo útil: Eventos disponíveis para este serviço. | Método | Evento | Chave no Swagger | Descrição | | --- | --- | --- | --- | | POST | Call - Vinculação | voice/pbx/call/link | | | POST | Call - Desvinculação | voice/pbx/call/unlink | |

### Call - Vinculação
- URL: https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx/call/post-voice-pbx-call-link
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST voice/pbx/call/link Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | channel | string | Sim | Exemplo: SIP/101pabx9999999.ligou.me-00001234 | Identificador do canal da ligação | | uniqueid | string | Sim | Exemplo: srv999-91234567.99 | Id da Chamada (Origem) | | subevent | string | Não | Exemplo: Begin | Definição do sub-evento. | | dialstatus | string | Não | Aceita: CHANUNAVAIL, CONGESTION, NOANSWER, BUSY, ANSWER, CANCEL · Exemplo: CANCEL | Status...

### Call - Desvinculação
- URL: https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx/call/post-voice-pbx-call-unlink
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST voice/pbx/call/unlink Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | channel | string | Sim | Exemplo: SIP/101pabx9999999.ligou.me-00001234 | Identificador do canal da ligação | | uniqueid | string | Sim | Exemplo: srv999-91234567.99 | Id da Chamada (Origem) | | subevent | string | Não | Exemplo: Begin | Definição do sub-evento. | | dialstatus | string | Não | Aceita: CHANUNAVAIL, CONGESTION, NOANSWER, BUSY, ANSWER, CANCEL · Exemplo: CANCEL | Statu...

### Channel
- URL: https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx/channel
- Resumo: Webhooks da Agilize para Channel em Voice - PBX.
- Conteúdo útil: Eventos disponíveis para este serviço. | Método | Evento | Chave no Swagger | Descrição | | --- | --- | --- | --- | | POST | Channel - Discagem | voice/pbx/channel/dial | | | POST | Channel - Encerramento | voice/pbx/channel/hangup | |

### Channel - Discagem
- URL: https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx/channel/post-voice-pbx-channel-dial
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST voice/pbx/channel/dial Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | channel | string | Sim | Exemplo: SIP/101pabx9999999.ligou.me-00001234 | Identificador do canal da ligação | | uniqueid | string | Sim | Exemplo: srv999-91234567.99 | Id da Chamada (Origem) | | subevent | string | Não | Exemplo: Begin | Definição do sub-evento. | | dialstatus | string | Não | Aceita: CHANUNAVAIL, CONGESTION, NOANSWER, BUSY, ANSWER, CANCEL · Exemplo: CANCEL | Stat...

### Channel - Encerramento
- URL: https://agilize.app/docs/desenvolvedores/webhooks/voice-pbx/channel/post-voice-pbx-channel-hangup
- Resumo: Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.
  - Seções: Evento | Como receber | Payload | Respostas | Boas práticas
- Conteúdo útil: Evento http POST voice/pbx/channel/hangup Como receber Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload. Payload - Content-Type: application/json | Campo | Tipo | Obrigatório | Valores / Exemplo | Descrição | | --- | --- | --- | --- | --- | | channel | string | Sim | Exemplo: SIP/101pabx9999999.ligou.me-00001234 | Identificador do canal da ligação | | uniqueid | string | Sim | Exemplo: srv999-91234567.99 | Id da Chamada (Origem) | | calleridnum | string | Não | Exemplo: 101 | Número da Bina (Canal Origem) | | calleridname | string | Não | Exemplo: Ramal João | Nome da Bina (Canal Origem) | | connectedlinenum | strin...

## Endpoints por assunto

### Arquivos - Upload

- GET /file/upload
  - Resumo: Documento - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/file-upload/arquivos/get-file-upload
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /file/upload/{_id}
  - Resumo: Documento - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/file-upload/arquivos/get-file-upload-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- GET /file/upload/download
  - Resumo: Documento - Download
  - Detalhe: Baixa um documento do serviço `file/upload` de forma segura. Para arquivos em storage externo, o endpoint redireciona para a URL assinada. Para arquivos locais, o endpoint entrega o binário diretamente.
  - Docs: https://agilize.app/docs/desenvolvedores/api/file-upload/downloads/get-file-upload-download
  - Parâmetros: x-api-key (header, obrigatório, string); id (query, obrigatório, string); view (query, opcional, boolean)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 Arquivo retornado diretamente pelo servidor.; 302 Redirecionamento para URL assinada do storage externo.; 400 Parâmetros inválidos.; 401 API key ausente ou inválida.; 404 Arquivo não encontrado ou sem acesso.
- GET /file/upload/url
  - Resumo: Documento - Resolver URL final de download
  - Detalhe: Retorna a URL final de download para um documento do serviço `file/upload`. Quando o arquivo está em storage externo, a resposta já devolve a URL assinada. Quando o arquivo ainda está local, a resposta devolve a rota autenticada `/file/upload/download`.
  - Docs: https://agilize.app/docs/desenvolvedores/api/file-upload/urls-de-upload/get-file-upload-url
  - Parâmetros: x-api-key (header, obrigatório, string); id (query, obrigatório, string); view (query, opcional, boolean)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 URL resolvida com sucesso.; 400 Parâmetros inválidos.; 401 API key ausente ou inválida.; 404 Arquivo não encontrado ou sem acesso.
- POST /file/upload
  - Resumo: Documento - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/file-upload/arquivos/post-file-upload
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: mimetype, name, size, category, md5, isTemp, canDelete, canDeleteLocal, localDeleteAfter, extStorage
  - Respostas: 201 created; 401 not authenticated; 500 general error
- PATCH /file/upload/{_id}
  - Resumo: Documento - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/file-upload/arquivos/patch-file-upload-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: mimetype, name, size, category, md5, isTemp, canDelete, canDeleteLocal, localDeleteAfter, extStorage
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /file/upload/{_id}
  - Resumo: Documento - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/file-upload/arquivos/delete-file-upload-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error

### CRM - Contatos

- GET /crm/contact/contact
  - Resumo: Contato - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-contact/contact/get-crm-contact-contact
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /crm/contact/contact/{_id}
  - Resumo: Contato - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-contact/contact/get-crm-contact-contact-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- POST /crm/contact/contact
  - Resumo: Contato - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-contact/contact/post-crm-contact-contact
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json
  - Respostas: 201 created; 401 not authenticated; 500 general error
- PATCH /crm/contact/contact/{_id}
  - Resumo: Contato - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-contact/contact/patch-crm-contact-contact-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: createdAt, name, automations, phones, emails, import, note, companies, leads, socials
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /crm/contact/contact/{_id}
  - Resumo: Contato - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-contact/contact/delete-crm-contact-contact-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error

### CRM - Empresas

- GET /crm/company/company
  - Resumo: Empresa - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-company/company/get-crm-company-company
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /crm/company/company/{_id}
  - Resumo: Empresa - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-company/company/get-crm-company-company-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- POST /crm/company/company
  - Resumo: Empresa - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-company/company/post-crm-company-company
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json
  - Respostas: 201 created; 401 not authenticated; 500 general error
- PATCH /crm/company/company/{_id}
  - Resumo: Empresa - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-company/company/patch-crm-company-company-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, automations, contacts, leads, phones, emails, socials, import, website, note
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /crm/company/company/{_id}
  - Resumo: Empresa - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-company/company/delete-crm-company-company-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error

### CRM - Oportunidades

- GET /crm/lead/archiveReason
  - Resumo: Motivo Arquivamento Lead - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/motivos-de-arquivamento/get-crm-lead-archivereason
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /crm/lead/archiveReason/{_id}
  - Resumo: Motivo Arquivamento Lead - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/motivos-de-arquivamento/get-crm-lead-archivereason-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- GET /crm/lead/funnel
  - Resumo: Funil - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/funis/get-crm-lead-funnel
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /crm/lead/funnel/{_id}
  - Resumo: Funil - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/funis/get-crm-lead-funnel-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- GET /crm/lead/lead
  - Resumo: Oportunidade - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/oportunidades/get-crm-lead-lead
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /crm/lead/lead/{_id}
  - Resumo: Oportunidade - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/oportunidades/get-crm-lead-lead-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- GET /crm/lead/source
  - Resumo: Origem Oportunidade - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/origens/get-crm-lead-source
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /crm/lead/source/{_id}
  - Resumo: Origem Oportunidade - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/origens/get-crm-lead-source-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- GET /crm/lead/stage
  - Resumo: Etapa do Funil - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/etapas/get-crm-lead-stage
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /crm/lead/stage/{_id}
  - Resumo: Etapa do Funil - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/etapas/get-crm-lead-stage-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- POST /crm/lead/archiveReason
  - Resumo: Motivo Arquivamento Lead - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/motivos-de-arquivamento/post-crm-lead-archivereason
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, funnels
  - Respostas: 201 created; 401 not authenticated; 500 general error
- POST /crm/lead/funnel
  - Resumo: Funil - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/funis/post-crm-lead-funnel
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, stages, deleted, validatePreviousStageRequirements, allowArchiveWithoutRequiredFields, disableDefaultWonLossStages, hideWonKanban, hideArchivedKanban
  - Respostas: 201 created; 401 not authenticated; 500 general error
- POST /crm/lead/lead
  - Resumo: Oportunidade - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/oportunidades/post-crm-lead-lead
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json
  - Respostas: 201 created; 401 not authenticated; 500 general error
- POST /crm/lead/source
  - Resumo: Origem Oportunidade - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/origens/post-crm-lead-source
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, color
  - Respostas: 201 created; 401 not authenticated; 500 general error
- POST /crm/lead/stage
  - Resumo: Etapa do Funil - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/etapas/post-crm-lead-stage
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json
  - Respostas: 201 created; 401 not authenticated; 500 general error
- PATCH /crm/lead/archiveReason/{_id}
  - Resumo: Motivo Arquivamento Lead - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/motivos-de-arquivamento/patch-crm-lead-archivereason-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, funnels
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- PATCH /crm/lead/funnel/{_id}
  - Resumo: Funil - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/funis/patch-crm-lead-funnel-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, stages, deleted, validatePreviousStageRequirements, allowArchiveWithoutRequiredFields, disableDefaultWonLossStages, hideWonKanban, hideArchivedKanban
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- PATCH /crm/lead/lead/{_id}
  - Resumo: Oportunidade - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/oportunidades/patch-crm-lead-lead-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: contacts, automations, companies, phones, emails, socials, name, user, createdBy, import
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- PATCH /crm/lead/source/{_id}
  - Resumo: Origem Oportunidade - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/origens/patch-crm-lead-source-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, color
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- PATCH /crm/lead/stage/{_id}
  - Resumo: Etapa do Funil - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/etapas/patch-crm-lead-stage-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: funnel, label, systemName, color, isFinal, finalType, order, transitionRules, deleted, updatedAt
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /crm/lead/archiveReason/{_id}
  - Resumo: Motivo Arquivamento Lead - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/motivos-de-arquivamento/delete-crm-lead-archivereason-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /crm/lead/funnel/{_id}
  - Resumo: Funil - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/funis/delete-crm-lead-funnel-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /crm/lead/lead/{_id}
  - Resumo: Oportunidade - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/oportunidades/delete-crm-lead-lead-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /crm/lead/source/{_id}
  - Resumo: Origem Oportunidade - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/origens/delete-crm-lead-source-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /crm/lead/stage/{_id}
  - Resumo: Etapa do Funil - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-lead/etapas/delete-crm-lead-stage-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error

### CRM - Suporte

- GET /crm/support/category
  - Resumo: Categoria de suporte - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-support/categorias/get-crm-support-category
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /crm/support/category/{_id}
  - Resumo: Categoria de suporte - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-support/categorias/get-crm-support-category-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- GET /crm/support/support
  - Resumo: Suporte - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-support/atendimentos/get-crm-support-support
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /crm/support/support/{_id}
  - Resumo: Suporte - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-support/atendimentos/get-crm-support-support-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- POST /crm/support/category
  - Resumo: Categoria de suporte - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-support/categorias/post-crm-support-category
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, parent, playbook, type
  - Respostas: 201 created; 401 not authenticated; 500 general error
- POST /crm/support/support
  - Resumo: Suporte - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-support/atendimentos/post-crm-support-support
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: customer, room, contact, number, subject, category, subCategory, department, team, user
  - Respostas: 201 created; 401 not authenticated; 500 general error
- PATCH /crm/support/category/{_id}
  - Resumo: Categoria de suporte - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-support/categorias/patch-crm-support-category-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, parent, playbook, type
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- PATCH /crm/support/support/{_id}
  - Resumo: Suporte - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-support/atendimentos/patch-crm-support-support-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: customer, room, contact, number, subject, category, subCategory, department, team, user
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /crm/support/category/{_id}
  - Resumo: Categoria de suporte - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-support/categorias/delete-crm-support-category-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /crm/support/support/{_id}
  - Resumo: Suporte - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-support/atendimentos/delete-crm-support-support-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error

### CRM - Tags

- GET /crm/tag/tag
  - Resumo: Tag - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-tag/tag/get-crm-tag-tag
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /crm/tag/tag/{_id}
  - Resumo: Tag - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-tag/tag/get-crm-tag-tag-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- POST /crm/tag/tag
  - Resumo: Tag - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-tag/tag/post-crm-tag-tag
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, color, ent, deleted
  - Respostas: 201 created; 401 not authenticated; 500 general error
- PATCH /crm/tag/tag/{_id}
  - Resumo: Tag - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-tag/tag/patch-crm-tag-tag-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, color, ent, deleted
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /crm/tag/tag/{_id}
  - Resumo: Tag - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-tag/tag/delete-crm-tag-tag-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error

### CRM - Timeline

- GET /crm/timeline/timeline
  - Resumo: Linha do Tempo - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-timeline/timeline/get-crm-timeline-timeline
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /crm/timeline/timeline/{_id}
  - Resumo: Linha do Tempo - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-timeline/timeline/get-crm-timeline-timeline-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- POST /crm/timeline/timeline
  - Resumo: Linha do Tempo - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-timeline/timeline/post-crm-timeline-timeline
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: contact, lead, task, pipeline, pipelineItem, pipelineStage, user, tags, begin, end
  - Respostas: 201 created; 401 not authenticated; 500 general error
- PATCH /crm/timeline/timeline/{_id}
  - Resumo: Linha do Tempo - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-timeline/timeline/patch-crm-timeline-timeline-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: contact, lead, task, pipeline, pipelineItem, pipelineStage, user, tags, begin, end
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /crm/timeline/timeline/{_id}
  - Resumo: Linha do Tempo - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/crm-timeline/timeline/delete-crm-timeline-timeline-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error

### Mensagens - Chat

- GET /messenger/chat/messageTemplate
  - Resumo: Modelo de Mensagem - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-chat/modelos-de-mensagem/get-messenger-chat-messagetemplate
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /messenger/chat/messageTemplate/{_id}
  - Resumo: Modelo de Mensagem - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-chat/modelos-de-mensagem/get-messenger-chat-messagetemplate-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- GET /messenger/chat/room
  - Resumo: Sala de Conversa - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-chat/salas-de-conversa/get-messenger-chat-room
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /messenger/chat/room/{_id}
  - Resumo: Sala de Conversa - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-chat/salas-de-conversa/get-messenger-chat-room-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- POST /messenger/chat/message/send
  - Resumo: Enviar mensagem (bot)
  - Detalhe: Envia uma mensagem em nome do bot (`fromBot: true`), persiste em `messenger/chat/message` e faz dispatch externo (WhatsApp/Facebook/Instagram) conforme o canal da room.
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-chat/mensagens/post-messenger-chat-message-send
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: room, message, file, files
  - Respostas: 200 Mensagem processada e persistida; 400 Payload inválido; 401 API key ausente ou inválida; 403 Sala não pertence ao projeto do usuário; 404 Sala não encontrada; 409 Configuração do canal não encontrada; 502 Falha ao enviar para o provider externo
- POST /messenger/chat/messageTemplate
  - Resumo: Modelo de Mensagem - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-chat/modelos-de-mensagem/post-messenger-chat-messagetemplate
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, language, category, bodyText, body, header, footer, buttons, business, phone
  - Respostas: 201 created; 401 not authenticated; 500 general error
- POST /messenger/chat/room
  - Resumo: Sala de Conversa - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-chat/salas-de-conversa/post-messenger-chat-room
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: guest, users, prefUser, owner, prefUserPendAttr, histUsers, tags, conversationDetailTags, department, contact
  - Respostas: 201 created; 401 not authenticated; 500 general error
- PATCH /messenger/chat/messageTemplate/{_id}
  - Resumo: Modelo de Mensagem - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-chat/modelos-de-mensagem/patch-messenger-chat-messagetemplate-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, language, category, bodyText, body, header, footer, buttons, business, phone
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- PATCH /messenger/chat/room/{_id}
  - Resumo: Sala de Conversa - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-chat/salas-de-conversa/patch-messenger-chat-room-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: guest, users, prefUser, owner, prefUserPendAttr, histUsers, tags, conversationDetailTags, department, contact
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /messenger/chat/messageTemplate/{_id}
  - Resumo: Modelo de Mensagem - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-chat/modelos-de-mensagem/delete-messenger-chat-messagetemplate-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /messenger/chat/room/{_id}
  - Resumo: Sala de Conversa - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-chat/salas-de-conversa/delete-messenger-chat-room-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error

### Mensagens - Meta

- GET /messenger/meta/phone
  - Resumo: WhatsApp - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-meta/phone/get-messenger-meta-phone
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /messenger/meta/phone/{_id}
  - Resumo: WhatsApp - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-meta/phone/get-messenger-meta-phone-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- POST /messenger/meta/phone
  - Resumo: WhatsApp - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-meta/phone/post-messenger-meta-phone
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: phone, phoneNumberId, status, business, flow, users, meta, isRegistered, integrationType, sendAgentName
  - Respostas: 201 created; 401 not authenticated; 500 general error
- PATCH /messenger/meta/phone/{_id}
  - Resumo: WhatsApp - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-meta/phone/patch-messenger-meta-phone-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: phone, phoneNumberId, status, business, flow, users, meta, isRegistered, integrationType, sendAgentName
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /messenger/meta/phone/{_id}
  - Resumo: WhatsApp - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-meta/phone/delete-messenger-meta-phone-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error

### Mensagens - SMS

- GET /messenger/sms/send
  - Resumo: Envio de SMS - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-sms/send/get-messenger-sms-send
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /messenger/sms/send/{_id}
  - Resumo: Envio de SMS - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-sms/send/get-messenger-sms-send-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- POST /messenger/sms/send
  - Resumo: Envio de SMS - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-sms/send/post-messenger-sms-send
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: phone, content, user, room, dt, extId, hasReply, extCodStaDetail, extCodSta, pendingRev
  - Respostas: 201 created; 401 not authenticated; 500 general error
- PATCH /messenger/sms/send/{_id}
  - Resumo: Envio de SMS - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-sms/send/patch-messenger-sms-send-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: phone, content, user, room, dt, extId, hasReply, extCodStaDetail, extCodSta, pendingRev
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /messenger/sms/send/{_id}
  - Resumo: Envio de SMS - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-sms/send/delete-messenger-sms-send-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error

### Mensagens - WhatsApp

- GET /messenger/whatsapp/send
  - Resumo: Envio WhatsApp - Busca e listagem de registros
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-whatsapp/send/get-messenger-whatsapp-send
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 500 general error
- GET /messenger/whatsapp/send/{_id}
  - Resumo: Envio WhatsApp - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-whatsapp/send/get-messenger-whatsapp-send-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- POST /messenger/whatsapp/send
  - Resumo: Envia um template de WhatsApp para o destino informado. Use `persistOnRoom` para tambem registrar o envio no historico da conversa quando aplicavel.
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-whatsapp/send/post-messenger-whatsapp-send
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json
  - Respostas: 201 created; 401 not authenticated; 500 general error
- PATCH /messenger/whatsapp/send/{_id}
  - Resumo: Envio WhatsApp - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-whatsapp/send/patch-messenger-whatsapp-send-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: destination, phone, varHeader, varsBody, varOrder, template, dt, extId, status
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error
- DELETE /messenger/whatsapp/send/{_id}
  - Resumo: Envio WhatsApp - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/messenger-whatsapp/send/delete-messenger-whatsapp-send-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 500 general error

### Usuários

- GET /user/user
  - Resumo: Usuário - Busca e listagem de registros. Este endpoint REST possui limite rígido de 1 requisição a cada 10 segundos por IP. Para integrações, prefira sincronização periódica via cron ou rotina similar, evitando consultas em alta frequência.
  - Docs: https://agilize.app/docs/desenvolvedores/api/user-user/usuarios/get-user-user
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 429 Limite excedido para este endpoint REST. Maximo de 1 requisicao a cada 10 segundos por IP.; 500 general error
- GET /user/user/{_id}
  - Resumo: Usuário - Retornar registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/user-user/usuarios/get-user-user-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 429 Limite excedido para este endpoint REST. Maximo de 1 requisicao a cada 10 segundos por IP.; 500 general error
- POST /user/user
  - Resumo: Usuário - Criação de novo registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/user-user/usuarios/post-user-user
  - Parâmetros: x-api-key (header, obrigatório, string); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, email, password, group, ownerCompany, currentProject, primaryTeamOrg, isTeamSupervisor, role, additionalInfo
  - Respostas: 201 created; 401 not authenticated; 429 Limite excedido para este endpoint REST. Maximo de 1 requisicao a cada 10 segundos por IP.; 500 general error
- PATCH /user/user/{_id}
  - Resumo: Usuário - Atualização de campos do registro.
  - Docs: https://agilize.app/docs/desenvolvedores/api/user-user/usuarios/patch-user-user-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: obrigatório; application/json; campos principais: name, email, password, group, ownerCompany, currentProject, primaryTeamOrg, isTeamSupervisor, role, additionalInfo
  - Respostas: 200 success; 401 not authenticated; 404 not found; 429 Limite excedido para este endpoint REST. Maximo de 1 requisicao a cada 10 segundos por IP.; 500 general error
- DELETE /user/user/{_id}
  - Resumo: Usuário - Exclusão do registro
  - Docs: https://agilize.app/docs/desenvolvedores/api/user-user/usuarios/delete-user-user-id
  - Parâmetros: x-api-key (header, obrigatório, string); _id (path, obrigatório, integer); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 401 not authenticated; 404 not found; 429 Limite excedido para este endpoint REST. Maximo de 1 requisicao a cada 10 segundos por IP.; 500 general error

### Voz - PBX

- GET /voice/pbx/cdr/cdr
  - Resumo: Registro de Chamada - Busca e listagem de registros
  - Detalhe: Registro de Chamada - Busca e listagem de registros. Este endpoint pode ser utilizado para busca por range de data **(no máximo 7 dias)** ou por **uniqueid**.
  - Docs: https://agilize.app/docs/desenvolvedores/api/voice-pbx/chamadas/get-voice-pbx-cdr-cdr
  - Parâmetros: x-api-key (header, obrigatório, string); $limit (query, opcional, integer); $skip (query, opcional, integer); $sort (query, opcional, object); filter (query, opcional, object); content-type (header, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 success; 400 bad request; 401 not authenticated; 500 general error
- GET /voice/pbx/cdr/download
  - Resumo: Registro de Chamada - Download Gravação
  - Detalhe: Este endpoint permite fazer o download de uma gravação de chamada. O usuário tem um limite mensal de **20.000** downloads. Caso esse limite não seja suficiente, por favor, entre em contato com o gestor de contas.
  - Docs: https://agilize.app/docs/desenvolvedores/api/voice-pbx/chamadas/get-voice-pbx-cdr-download
  - Parâmetros: x-api-key (header, obrigatório, string); uniqueid (query, obrigatório, string)
  - Corpo: não declara corpo de requisição
  - Respostas: 200 Download do arquivo CDR bem-sucedido.; 405 You have exceeded the monthly limit of [LIMIT] download requests. Talk to your account manager for more information.; 410 CDR not found, verify uniqueid.; 411 Recording not available for this CDR