# Documentação | JuriChat

## Docs

- [Introdução](https://docs.jurichat.com/index.md): Documentação oficial da API do JuriChat.
- [Autenticação](https://docs.jurichat.com/autenticacao.md): Como autenticar requisições na API do JuriChat.
- [Status Codes](https://docs.jurichat.com/status-code.md): Códigos de status utilizados pela API.
- [Introdução](https://docs.jurichat.com/api-reference/introduction.md): Referência completa dos endpoints da API do JuriChat.
- [Webhooks](https://docs.jurichat.com/api-reference/untitled-page.md)
- [Obter escritório](https://docs.jurichat.com/api-reference/office/obter-escritório.md): Retorna os dados do escritório pelo ID, incluindo saldo de créditos por módulo.
- [Update office](https://docs.jurichat.com/api-reference/office/update-office.md): Update office
- [Listar usuários](https://docs.jurichat.com/api-reference/users/listar-usuários.md): Lista todos os usuários do escritório do solicitante, com busca por nome ou e-mail e filtro por papel. Informe `inboxId` para filtrar por uma inbox (workspace) específica. Use `page` e `limit` para paginar.
- [Criar usuário](https://docs.jurichat.com/api-reference/users/criar-usuário.md): Cria operador no escritório com papel, senha e vínculo a uma ou mais inboxes. Conflito de e-mail: 409.
- [Obter configuração da sidebar](https://docs.jurichat.com/api-reference/users/obter-configuração-da-sidebar.md): Retorna a configuração de sidebar do usuário autenticado. Array vazio indica que o padrão deve ser usado.
- [Atualizar configuração da sidebar](https://docs.jurichat.com/api-reference/users/atualizar-configuração-da-sidebar.md): Salva a ordem e visibilidade dos itens da sidebar do usuário autenticado. Enviar `items: []` restaura o padrão.
- [Obter configuração dos cards do CRM](https://docs.jurichat.com/api-reference/users/obter-configuração-dos-cards-do-crm.md): Retorna os campos exibidos nos cards do CRM para o usuário autenticado.
- [Atualizar configuração dos cards do CRM](https://docs.jurichat.com/api-reference/users/atualizar-configuração-dos-cards-do-crm.md): Salva os campos exibidos nos cards do CRM para o usuário autenticado.
- [Obter usuário](https://docs.jurichat.com/api-reference/users/obter-usuário.md): Retorna os dados de um usuário pelo ID, incluindo papel, escritório, inboxes e permissões ativas.
- [Excluir usuário](https://docs.jurichat.com/api-reference/users/excluir-usuário.md): Remove permanentemente o usuário. Pode afetar dados vinculados como conversas e inboxes.
- [Atualizar usuário](https://docs.jurichat.com/api-reference/users/atualizar-usuário.md): Atualização parcial: apenas os campos enviados são modificados. Enviar `inboxId` substitui as inboxes do usuário.
- [Listar inboxes](https://docs.jurichat.com/api-reference/inboxes/listar-inboxes.md): Lista todas as inboxes do escritório. Filtros opcionais por nome e integração.
- [Create Inbox](https://docs.jurichat.com/api-reference/inboxes/create-inbox.md): Cria uma nova caixa de entrada
- [Obter inbox](https://docs.jurichat.com/api-reference/inboxes/obter-inbox.md): Retorna os dados de uma inbox pelo ID.
- [Update Inbox](https://docs.jurichat.com/api-reference/inboxes/update-inbox.md): Atualiza uma caixa de entrada existente
- [Delete Inbox](https://docs.jurichat.com/api-reference/inboxes/delete-inbox.md): Remove uma caixa de entrada existente
- [Listar integrações](https://docs.jurichat.com/api-reference/integration/listar-integrações.md): Lista as integrações de uma inbox. Filtro opcional por canal.
- [Obter integração](https://docs.jurichat.com/api-reference/integration/obter-integração.md): Retorna os dados de uma integração pelo ID. O `inboxId` é obrigatório para garantir que a integração pertence à inbox informada.
- [Delete integration](https://docs.jurichat.com/api-reference/integration/delete-integration.md): Delete integration
- [Update integration](https://docs.jurichat.com/api-reference/integration/update-integration.md): Update integration
- [Listar aparelhos de WhatsApp do escritório](https://docs.jurichat.com/api-reference/integration/listar-aparelhos-de-whatsapp-do-escritório.md): Lista as conexões LITE_WHATSAPP do escritório, incluindo as desconectadas. Usado pelo Juridiq para escolher por qual aparelho os lembretes de audiência saem. WhatsApp Oficial fica de fora da listagem até o Juridiq suportar seleção de template; o POST audience-reminder e o GET de templates já aceitam…
- [Listar templates WhatsApp Oficial do aparelho](https://docs.jurichat.com/api-reference/integration/listar-templates-whatsapp-oficial-do-aparelho.md): Lista templates APPROVED (por padrão) da integração WhatsApp Oficial indicada por `deviceId`. Escopo pelo escritório do portador da API key.
- [Enviar lembrete de audiência](https://docs.jurichat.com/api-reference/integration/enviar-lembrete-de-audiência.md): Envia um lembrete de audiência pelo aparelho indicado, criando ou reaproveitando o contato e a conversa. No WhatsApp Oficial exige `templateName`. Idempotente por `idempotencyKey`.
- [Listar templates de WhatsApp](https://docs.jurichat.com/api-reference/templates/listar-templates-de-whatsapp.md): Retorna os templates de mensagem cadastrados na WABA vinculada à integração. Apenas templates com status `APPROVED` podem ser enviados em conversas.
- [Criar template de WhatsApp](https://docs.jurichat.com/api-reference/templates/criar-template-de-whatsapp.md): Submete um novo template à aprovação da Meta. A análise não é instantânea: o template nasce com status `PENDING` e só pode ser enviado após virar `APPROVED`. Cabeçalhos de mídia exigem o handle devolvido por `POST /integration/templates/{integrationId}/media` em `example.header_handle`.
- [Enviar mídia do cabeçalho de template](https://docs.jurichat.com/api-reference/templates/enviar-mídia-do-cabeçalho-de-template.md): Faz upload de uma mídia para a Meta e devolve o handle usado em cabeçalhos IMAGE, VIDEO ou DOCUMENT. Envie como `multipart/form-data` com os campos `file` (arquivo) e `type` (image, video ou document). O handle é obrigatório ao criar um template com cabeçalho de mídia.
- [Atualizar template de WhatsApp](https://docs.jurichat.com/api-reference/templates/atualizar-template-de-whatsapp.md): Altera os componentes de um template existente. Nome, categoria e idioma não podem ser alterados — para mudá-los, crie um novo template. Toda edição envia o template para nova análise da Meta.
- [Excluir template de WhatsApp](https://docs.jurichat.com/api-reference/templates/excluir-template-de-whatsapp.md): Remove o template da WABA pelo nome. A exclusão é definitiva e apaga todas as versões de idioma registradas sob esse nome. Mensagens já enviadas não são afetadas.
- [Listar conversas](https://docs.jurichat.com/api-reference/conversations/listar-conversas.md): Lista conversas da inbox com filtros por status, prioridade, canal, tags e texto. Use `page` e `limit` para paginar.
- [Criar conversa](https://docs.jurichat.com/api-reference/conversations/criar-conversa.md): Cria uma conversa individual com o contato informado. Se já existir uma conversa ativa, retorna a existente.
- [Contadores de conversas](https://docs.jurichat.com/api-reference/conversations/contadores-de-conversas.md): Retorna os contadores dos filtros rápidos (total, minhas e aguardando) para os filtros aplicados na listagem.
- [Listar notas](https://docs.jurichat.com/api-reference/conversations/listar-notas.md): Lista notas internas da conversa, com autor quando disponível.
- [Status da janela WhatsApp oficial](https://docs.jurichat.com/api-reference/conversations/status-da-janela-whatsapp-oficial.md): Retorna o status da janela de mensagens para WhatsApp API Oficial e Instagram Direct.
- [Verificação do número no WhatsApp](https://docs.jurichat.com/api-reference/conversations/verificação-do-número-no-whatsapp.md): Verifica na uazapi se o número do contato da conversa está registrado no WhatsApp. Aplica-se apenas a conversas do canal LITE_WHATSAPP; nos demais casos retorna NOT_APPLICABLE.
- [Upload de mídia do cabeçalho de template](https://docs.jurichat.com/api-reference/conversations/upload-de-mídia-do-cabeçalho-de-template.md): Faz upload de imagem, vídeo ou documento para uso no cabeçalho de envio de template WhatsApp.
- [Obter conversa](https://docs.jurichat.com/api-reference/conversations/obter-conversa.md): Retorna os dados de uma conversa com participantes, tags e mensagens. Use `cursor` e `limit` para paginar as mensagens.
- [Excluir conversa](https://docs.jurichat.com/api-reference/conversations/excluir-conversa.md): Remove a conversa e suas mensagens associadas.
- [Atualizar conversa](https://docs.jurichat.com/api-reference/conversations/atualizar-conversa.md): Atualização parcial: apenas os campos enviados são aplicados. Campos omitidos não são alterados.
- [Criar nota interna](https://docs.jurichat.com/api-reference/conversations/criar-nota-interna.md): Insere nota privada visível aos operadores na conversa.
- [Iniciar atendimento humano ou transferir](https://docs.jurichat.com/api-reference/conversations/iniciar-atendimento-humano-ou-transferir.md): Transfere a conversa para atendimento humano. Permite atribuir a um atendente específico ou a um aleatório, com opção de notificar o contato.
- [Encerrar atendimento humano](https://docs.jurichat.com/api-reference/conversations/encerrar-atendimento-humano.md): Encerra o atendimento humano e devolve a conversa para o fluxo automático.
- [Enviar mensagem](https://docs.jurichat.com/api-reference/conversations/enviar-mensagem.md): Envia uma mensagem na conversa. O body deve ser enviado como `multipart/form-data`.
- [Editar mensagem enviada](https://docs.jurichat.com/api-reference/conversations/editar-mensagem-enviada.md): Edita uma mensagem de texto enviada pelo WhatsApp Lite dentro da janela permitida pelo WhatsApp.
- [Remover mensagem](https://docs.jurichat.com/api-reference/conversations/remover-mensagem.md): Remove uma mensagem da conversa.
- [Encaminhar mensagens](https://docs.jurichat.com/api-reference/conversations/encaminhar-mensagens.md): Encaminha uma ou mais mensagens para uma ou mais conversas.
- [Baixar mídia da mensagem](https://docs.jurichat.com/api-reference/conversations/baixar-mídia-da-mensagem.md): Redireciona (302) para a URL de download do arquivo da mensagem. O link tem validade de aproximadamente 5 minutos.
- [Sincronizar mensagens (WhatsApp)](https://docs.jurichat.com/api-reference/conversations/sincronizar-mensagens-whatsapp.md): Sincroniza o histórico de mensagens do WhatsApp para a conversa informada.
- [Arquivar ou desarquivar conversa](https://docs.jurichat.com/api-reference/conversations/arquivar-ou-desarquivar-conversa.md): Arquiva ou desarquiva a conversa conforme o valor de `isArchived`.
- [Listar contatos](https://docs.jurichat.com/api-reference/contacts/listar-contatos.md): Lista contatos da inbox com filtros por nome, e-mail, bloqueio e tags. Use `page` e `limit` juntos para paginar; sem eles, retorna todos os registros.
- [Criar contato](https://docs.jurichat.com/api-reference/contacts/criar-contato.md): Cria um novo contato vinculado à inbox informada. As tags devem existir na mesma inbox. Conflito de dados únicos retorna 409.
- [Excluir contatos](https://docs.jurichat.com/api-reference/contacts/excluir-contatos.md): Remove um ou mais contatos pelos IDs informados.
- [Obter contato](https://docs.jurichat.com/api-reference/contacts/obter-contato.md): Retorna os dados de um contato pelo ID. O `inboxId` é obrigatório para garantir que o contato pertença à inbox informada.
- [Atualizar contato](https://docs.jurichat.com/api-reference/contacts/atualizar-contato.md): Atualização parcial: campos omitidos não são zerados. `tags`, quando presente, redefine todas as associações na inbox.
- [Obter tag](https://docs.jurichat.com/api-reference/tags/obter-tag.md): Retorna os dados de uma tag pelo ID.
- [Excluir tag](https://docs.jurichat.com/api-reference/tags/excluir-tag.md): Remove a tag pelo ID. Retorna 204 sem corpo em caso de sucesso.
- [Atualizar tag](https://docs.jurichat.com/api-reference/tags/atualizar-tag.md): Atualização parcial de nome, cor e/ou módulos de visibilidade da tag.
- [Listar tags](https://docs.jurichat.com/api-reference/tags/listar-tags.md): Retorna todas as tags vinculadas à inbox informada, com módulos de visibilidade e cor.
- [Criar tag](https://docs.jurichat.com/api-reference/tags/criar-tag.md): Cria uma tag vinculada à inbox informada, com cor e visibilidade por módulos.
- [Unificar etiquetas](https://docs.jurichat.com/api-reference/tags/unificar-etiquetas.md): Une uma ou mais etiquetas de origem em uma etiqueta de destino, reatribuindo todos os vínculos (conversas, pessoas, cards do CRM, respostas rápidas e regras de agente) e removendo as etiquetas de origem.
- [Listar mensagens rápidas](https://docs.jurichat.com/api-reference/fastmessages/listar-mensagens-rápidas.md): Lista as mensagens rápidas da inbox. Filtros opcionais por título e tags.
- [Criar mensagem rápida](https://docs.jurichat.com/api-reference/fastmessages/criar-mensagem-rápida.md): Cria uma mensagem rápida vinculada à inbox informada.
- [Excluir mensagem rápida](https://docs.jurichat.com/api-reference/fastmessages/excluir-mensagem-rápida.md): Remove a mensagem rápida pelo ID. Retorna 204 sem corpo em caso de sucesso.
- [Atualizar mensagem rápida](https://docs.jurichat.com/api-reference/fastmessages/atualizar-mensagem-rápida.md): Atualização parcial: apenas os campos enviados são modificados.
- [Listar cards de CRM](https://docs.jurichat.com/api-reference/crm/listar-cards-de-crm.md): Lista os cards de uma etapa do funil de CRM com filtro por contato e paginação.
- [Criar card de CRM](https://docs.jurichat.com/api-reference/crm/criar-card-de-crm.md): Cria um novo card em uma etapa do funil de CRM, vinculando um contato existente.
- [Excluir cards de CRM](https://docs.jurichat.com/api-reference/crm/excluir-cards-de-crm.md): Remove um ou mais cards do funil de CRM pelos IDs informados.
- [Obter card de CRM por contato e conversa](https://docs.jurichat.com/api-reference/crm/obter-card-de-crm-por-contato-e-conversa.md): Retorna o card de CRM vinculado ao contato na conversa informada. O funil é identificado automaticamente a partir da integração da conversa.
- [Obter card de CRM](https://docs.jurichat.com/api-reference/crm/obter-card-de-crm.md): Retorna os dados completos de um card pelo ID, incluindo contato, responsável, campos personalizados e tags.
- [Atualizar card de CRM](https://docs.jurichat.com/api-reference/crm/atualizar-card-de-crm.md): Atualização parcial do card. Apenas os campos enviados são modificados. Enviar `columnId` move o card para outra etapa do funil.
- [Mover cards em lote](https://docs.jurichat.com/api-reference/crm/mover-cards-em-lote.md): Move cards entre etapas do funil de CRM. Envie `cardIds` para mover cards específicos, ou `sourceColumnId` para mover todos os cards de uma etapa. Não é possível usar os dois ao mesmo tempo.
- [Listar mensagens agendadas](https://docs.jurichat.com/api-reference/scheduledmessages/listar-mensagens-agendadas.md): Lista mensagens agendadas com filtros por conversa, inbox e status. `page` padrão 1, `limit` padrão 20.
- [Agendar mensagem](https://docs.jurichat.com/api-reference/scheduledmessages/agendar-mensagem.md): Agenda uma mensagem para envio futuro. O body deve ser enviado como `multipart/form-data`. Em integrações WhatsApp Oficial, use `type: template` com `templateName` e variáveis.
- [Excluir mensagem agendada](https://docs.jurichat.com/api-reference/scheduledmessages/excluir-mensagem-agendada.md): Remove um agendamento (tipicamente em estado `PENDING`).
- [Atualizar mensagem agendada](https://docs.jurichat.com/api-reference/scheduledmessages/atualizar-mensagem-agendada.md): Atualiza um agendamento com status pendente. Apenas os campos enviados são modificados. O body deve ser enviado como `multipart/form-data`.
- [Cancelar mensagem agendada](https://docs.jurichat.com/api-reference/scheduledmessages/cancelar-mensagem-agendada.md): Cancela um agendamento pendente. O registro é mantido com status `CANCELLED`.
- [Listar eventos disponíveis](https://docs.jurichat.com/api-reference/webhooks/listar-eventos-disponíveis.md): Retorna o catálogo completo de eventos disponíveis para inscrição, agrupados por domínio. Use o campo `name` de cada evento ao criar ou atualizar um webhook.
- [Listar webhooks](https://docs.jurichat.com/api-reference/webhooks/listar-webhooks.md): Retorna todos os webhooks do escritório vinculado à autenticação (JWT ou chave de API), incluindo estatísticas de entrega (total, taxa de sucesso e falhas).
- [Criar webhook](https://docs.jurichat.com/api-reference/webhooks/criar-webhook.md): Cria um novo endpoint de webhook. O response inclui um `secret` que você deve armazenar — ele é usado para verificar o header `X-JuriChat-Signature` em cada entrega.
- [Obter um webhook](https://docs.jurichat.com/api-reference/webhooks/obter-um-webhook.md): Retorna os detalhes completos de um webhook específico, incluindo seu segredo de autenticação.
- [Deletar webhook](https://docs.jurichat.com/api-reference/webhooks/deletar-webhook.md): Exclui permanentemente um webhook e o histórico associado de entregas. Esta ação não pode ser desfeita.
- [Atualizar um webhook](https://docs.jurichat.com/api-reference/webhooks/atualizar-um-webhook.md): Atualiza parcialmente um webhook. Apenas os campos fornecidos são alterados.
- [Enviar um evento de teste](https://docs.jurichat.com/api-reference/webhooks/enviar-um-evento-de-teste.md): Envia um evento `webhook.test` sincronamente para a URL do webhook e retorna o resultado imediatamente. Use isso para verificar se seu endpoint está acessível e configurado corretamente.
- [Listar histórico de entregas](https://docs.jurichat.com/api-reference/webhooks/listar-histórico-de-entregas.md): Retorna uma lista paginada de tentativas de entrega para um webhook, ordenada pela mais recente primeiro. Registros são mantidos por 90 dias.
- [Obter uma entrega](https://docs.jurichat.com/api-reference/webhooks/obter-uma-entrega.md): Retorna os detalhes completos de uma tentativa de entrega, incluindo o payload exato enviado e a resposta recebida.
- [Retentar uma entrega](https://docs.jurichat.com/api-reference/webhooks/retentar-uma-entrega.md): Reenfileira manualmente uma entrega com status `FAILED` ou `RETRYING`. Somente entregas nesses status podem ser reprocessadas. O status volta para `PENDING` e uma nova tentativa é agendada imediatamente.
- [Obter progresso do tour guiado](https://docs.jurichat.com/api-reference/onboarding/obter-progresso-do-tour-guiado.md): Retorna o estado salvo do tour guiado do usuário. `state: null` quando ainda não há registro.
- [Salvar progresso do tour guiado](https://docs.jurichat.com/api-reference/onboarding/salvar-progresso-do-tour-guiado.md): Grava (upsert) o estado do tour guiado do usuário autenticado.

## OpenAPI Specs

- [openapi](https://docs.jurichat.com/api-reference/openapi.json)