# Wegly

## Docs

- [Detalhe de arquivo](https://docs.wegly.com.br/api-reference/arquivos/detalhe-de-arquivo.md): Retorna os metadados de um arquivo individual e a URL assinada correspondente. O arquivo precisa estar vinculado a um lead ou negócio visível ao usuário criador da chave.
- [Listagem de arquivos por contexto](https://docs.wegly.com.br/api-reference/arquivos/listagem-de-arquivos-por-contexto.md): Lista arquivos vinculados a um lead ou negócio. - É obrigatório informar exatamente um contexto entre `crm_lead_id`, `crm_deal_id`, `lead_code` ou `deal_code`. - `lead_code` e `deal_code` resolvem o registro acessível do usuário criador da chave antes da consulta. - O retorno segue o formato plano d…
- [Remoção lógica de arquivo](https://docs.wegly.com.br/api-reference/arquivos/remoção-lógica-de-arquivo.md): Remove logicamente um arquivo individual e ajusta os totais do lote relacionado. O arquivo precisa estar vinculado a um lead ou negócio visível ao usuário criador da chave.
- [Upload de arquivos para lead ou negócio](https://docs.wegly.com.br/api-reference/arquivos/upload-de-arquivos-para-lead-ou-negócio.md): Cria um lote de arquivos pela API pública de integrações externas. - É obrigatório informar exatamente um contexto entre `crm_lead_id`, `crm_deal_id`, `lead_code` ou `deal_code`. - Os arquivos devem ser enviados em `file` ou `files`. - Os formatos suportados são `markdown (.md/.markdown)`, `pdf`, `d…
- [Listagem de campos personalizados](https://docs.wegly.com.br/api-reference/campos-personalizados/listagem-de-campos-personalizados.md): Retorna os campos personalizados cadastrados para a empresa associada à chave de integração. - O resultado respeita o escopo da empresa da chave. - O ator da operação é o usuário que criou a chave, reaproveitando as mesmas regras do módulo interno. - `entity_type` permite filtrar por campos de lead…
- [Consulta de chat](https://docs.wegly.com.br/api-reference/chats/consulta-de-chat.md): Retorna os detalhes completos de um chat específico com participantes, vínculo CRM e última mensagem.
- [Criação manual de chat](https://docs.wegly.com.br/api-reference/chats/criação-manual-de-chat.md): Cria ou reaproveita um chat manualmente e sempre dispara um template do WhatsApp como primeira mensagem. - É obrigatório informar `template.name` e `template.language`. - O destino deve ser enviado por `wa_contact_id` ou `person_contact_id`. - Quando `person_contact_id` é usado, ele tem prioridade s…
- [Envio de mensagem para chat](https://docs.wegly.com.br/api-reference/chats/envio-de-mensagem-para-chat.md): Envia uma mensagem de texto, template ou mídia para um chat existente no escopo da chave de integração. A operação usa o usuário criador da chave como ator, exige permissão `crm/chats.write` e aguarda o retorno imediato da Meta para manter compatibilidade com integrações externas. Para mensagens int…
- [Listagem de chats](https://docs.wegly.com.br/api-reference/chats/listagem-de-chats.md): Retorna os chats da empresa vinculada à chave de integração com os mesmos filtros operacionais do módulo interno. O ator da operação é sempre o usuário criador da chave, reaproveitando o mesmo escopo de administrador, agente responsável ou participante.
- [Resumo de não lidas](https://docs.wegly.com.br/api-reference/chats/resumo-de-não-lidas.md): Retorna o consolidado de mensagens e chats com indicador de não lida ativo para o escopo da chave de integração.
- [Adicionar seguidor ao lead](https://docs.wegly.com.br/api-reference/leads/adicionar-seguidor-ao-lead.md): Adiciona ou reativa um usuário como seguidor do lead usando o usuário criador da chave de integração como ator. Se o usuário já for seguidor ativo, a função e as observações são atualizadas sem duplicar o vínculo.
- [Atualização de lead](https://docs.wegly.com.br/api-reference/leads/atualização-de-lead.md): Atualiza campos do lead. Somente campos enviados são considerados. - O campo `lead_source` não é aceito nesta API; utilize `crm_lead_source_id`. - Enviar ao mesmo tempo `organization_id` e `organization` resulta em erro. - Para remover a organização vinculada, envie `organization_id` como `null`. -…
- [Consulta de lead](https://docs.wegly.com.br/api-reference/leads/consulta-de-lead.md): Retorna detalhes completos do lead informado. O `id` pode ser UUID ou o código numérico interno. Considera visibilidade do usuário criador da chave.
- [Criação de lead](https://docs.wegly.com.br/api-reference/leads/criação-de-lead.md): Cria um lead na empresa vinculada à chave de integração usando o usuário que criou a chave como ator padrão. - O estágio padrão é a primeira etapa do funil primário se `stage_id` não for informado. - Se `responsible_id` não for enviado, o responsável será o criador da chave. - A única forma de infor…
- [Listagem de leads](https://docs.wegly.com.br/api-reference/leads/listagem-de-leads.md): Retorna leads da empresa associada à chave de integração com paginação e filtros. A visibilidade do resultado considera as regras de acesso do usuário criador da chave (visibilidade 2 = público, 1 = equipe/responsável, 0 = privado para responsável/supervisão).
- [Remover seguidor do lead](https://docs.wegly.com.br/api-reference/leads/remover-seguidor-do-lead.md): Remove logicamente um usuário da lista de seguidores do lead usando o usuário criador da chave de integração como ator.
- [Adicionar seguidor à oportunidade](https://docs.wegly.com.br/api-reference/oportunidades/adicionar-seguidor-à-oportunidade.md): Adiciona ou reativa um usuário como seguidor da oportunidade usando o usuário criador da chave de integração como ator. Se o usuário já for seguidor ativo, a função e as observações são atualizadas sem duplicar o vínculo.
- [Atualização de oportunidade](https://docs.wegly.com.br/api-reference/oportunidades/atualização-de-oportunidade.md): Atualiza campos da oportunidade. O campo `lead_source` não é aceito; use `crm_lead_source_id`. Conflitos entre `organization_id` e `organization` são rejeitados. Pessoas marcadas com `delete: true` em `persons_id` são removidas; `organization_id: null` remove a organização.
- [Consulta de oportunidade](https://docs.wegly.com.br/api-reference/oportunidades/consulta-de-oportunidade.md): Retorna detalhes completos da oportunidade informada, incluindo propostas e produtos diretos associados. O `id` pode ser UUID ou o código numérico interno.
- [Criação de oportunidades](https://docs.wegly.com.br/api-reference/oportunidades/criação-de-oportunidades.md): Cria uma oportunidade (deal) usando a chave de integração, aplicando as mesmas validações internas: estágio/responsável padrão quando omitidos, conflito proibido entre `organization_id` e `organization`, origem manual aceita apenas por `crm_lead_source_id` (`lead_source` não é suportado), deduplicaç…
- [Listagem de oportunidades](https://docs.wegly.com.br/api-reference/oportunidades/listagem-de-oportunidades.md): Retorna oportunidades da empresa associada à chave de integração com paginação e filtros. A visibilidade segue o usuário criador da chave (público, equipe/responsável ou privado).
- [Remover seguidor da oportunidade](https://docs.wegly.com.br/api-reference/oportunidades/remover-seguidor-da-oportunidade.md): Remove logicamente um usuário da lista de seguidores da oportunidade usando o usuário criador da chave de integração como ator.
- [Atualização de proposta](https://docs.wegly.com.br/api-reference/propostas/atualização-de-proposta.md): Atualiza a proposta informada. - `deal_code` pode ser usado para trocar o contexto do negócio sem enviar `deal_id`. - Quando `items` é enviado, a lista inteira é reprocessada e aceita remoções com `delete: true`. - Itens com `sku` e sem `product_id` são resolvidos pelo catálogo da empresa.
- [Consulta de proposta](https://docs.wegly.com.br/api-reference/propostas/consulta-de-proposta.md): Retorna os detalhes completos de uma proposta específica da empresa da chave.
- [Criação de proposta](https://docs.wegly.com.br/api-reference/propostas/criação-de-proposta.md): Cria uma proposta comercial usando o usuário criador da chave como ator da operação. - `items` é obrigatório e deve conter ao menos um item válido. - `deal_id` e `deal_code` são formas alternativas de apontar o negócio de contexto. - Quando `sku` é informado em um item sem `product_id`, a API resolv…
- [Listagem de propostas](https://docs.wegly.com.br/api-reference/propostas/listagem-de-propostas.md): Retorna propostas da empresa associada à chave de integração com filtros por lead, negócio, autor, status e períodos. O ator reaproveita o usuário criador da chave e o filtro `deal_code` converte o código numérico do negócio para o ID interno antes da consulta.
- [Remoção de proposta](https://docs.wegly.com.br/api-reference/propostas/remoção-de-proposta.md): Realiza a exclusão lógica da proposta e devolve o identificador removido.
- [Criação de link público de satisfação](https://docs.wegly.com.br/api-reference/satisfação/criação-de-link-público-de-satisfação.md): Cria um link público tokenizado para resposta de um formulário de satisfação. O endpoint usa a empresa da chave de integração, exige permissão `crm/satisfaction.links.create`, resolve o usuário ator como o criador da chave e reaproveita as mesmas validações internas de formulário, pessoa, oportunida…
- [Atualização de tarefa](https://docs.wegly.com.br/api-reference/tarefas/atualização-de-tarefa.md): Atualiza uma tarefa existente via integração externa. Em tarefas recorrentes, `recurrence_scope` define se a alteração afeta apenas a ocorrência atual, futuras, abertas ou toda a série.
- [Consulta de tarefa](https://docs.wegly.com.br/api-reference/tarefas/consulta-de-tarefa.md): Retorna o detalhamento de uma tarefa específica visível ao usuário criador da chave de integração.
- [Criação de tarefa](https://docs.wegly.com.br/api-reference/tarefas/criação-de-tarefa.md): Cria uma tarefa via integração externa, usando o usuário criador da chave como ator. A tarefa pode ser vinculada a exatamente um contexto principal entre lead, oportunidade, entrega, pessoa ou organização, conforme as regras do módulo interno.
- [Listagem de tarefas](https://docs.wegly.com.br/api-reference/tarefas/listagem-de-tarefas.md): Retorna tarefas da empresa associada à chave de integração. A listagem reaproveita o mesmo escopo do módulo interno e permite filtrar tarefas vinculadas a leads, oportunidades, entregas, pessoas ou organizações.
- [Remoção de tarefa](https://docs.wegly.com.br/api-reference/tarefas/remoção-de-tarefa.md): Remove logicamente uma tarefa. Para tarefas recorrentes, `recurrence_scope` pode controlar se a remoção vale apenas para a ocorrência atual, futuras, abertas ou toda a série.
- [Eventos de Webhooks](https://docs.wegly.com.br/documentacao-da-api/eventos-de-webhooks/index.md): Eventos que a API da Wegly pode disparar para webhooks configurados, com payloads e tipos enviados em cada disparo.
- [Autenticação](https://docs.wegly.com.br/documentacao-da-api/integracoes/autenticacao.md)
- [Principal](https://docs.wegly.com.br/documentacao-da-api/integracoes/index.md): Nesta seção, você encontrará todas as informações necessárias para integrar suas aplicações à Wegly.
- [Bem-vindo à central de ajuda Wegly!](https://docs.wegly.com.br/index.md)
- [POLÍTICA DE PRIVACIDADE DA WEGLY](https://docs.wegly.com.br/politica-de-privacidade.md)
- [TERMOS DE USO DA WEGLY](https://docs.wegly.com.br/termos-de-uso.md)

## OpenAPI Specs

- [openapi](https://docs.wegly.com.br/openapi.json)
- [leads](https://docs.wegly.com.br/leads.json)
- [openapi-wegly-leads](https://docs.wegly.com.br/api-reference/openapi-wegly-leads.json)

## Optional

- [Wegly](https://wegly.com.br)
- [Blog](https://blog.wegly.com.br)