# GoZAP API — documentação para IA

Artefatos gerados a partir da coleção Postman. Para editar a documentação, altere a coleção; a UI humana está em [/docs](https://gozap.dev/docs).

- [OpenAPI 3](./openapi.json)
- [llms.txt](https://gozap.dev/llms.txt)
- [Collection Postman (UI)](https://gozap.dev/docs)

## Pastas

### [Sistema](./sistema/index.md)

- [`GET /health`](./sistema/get-health.md) — Verificar saúde da API
- [`GET /health/overview`](./sistema/get-health-overview.md) — Health check detalhado
- [`GET /`](./sistema/get-root.md) — Informações da raiz da API
- [`GET /ready`](./sistema/get-ready.md) — Verificar prontidão da API
- [`POST /sticker/pack`](./sistema/post-sticker-pack.md) — Buscar pacote de figurinhas
- [`POST /profile/disappearing`](./sistema/post-profile-disappearing.md) — Obter ou definir mensagens temporárias do perfil
- [`POST /pay/account`](./sistema/post-pay-account.md) — Obter conta de pagamento
- [`POST /spam/report`](./sistema/post-spam-report.md) — Denunciar spam (lista de mensagens)
- [`POST /abt/props`](./sistema/post-abt-props.md) — Obter propriedades de teste A/B
- [`GET /admin/call/template`](./sistema/get-admin-call-template.md) — Obter template da página /call
- [`GET /admin/call/template/default`](./sistema/get-admin-call-template-default.md) — Obter template padrão da página /call
- [`PUT /admin/call/template`](./sistema/put-admin-call-template.md) — Salvar template customizado da página /call
- [`DELETE /admin/call/template`](./sistema/delete-admin-call-template.md) — Remover template customizado da página /call
- [`GET /metrics`](./sistema/get-metrics.md) — GET /metrics
- [`POST /device/coexistence/connect`](./sistema/post-device-coexistence-connect.md) — Conectar plataforma Business por coexistência
- [`DELETE /device/coexistence`](./sistema/delete-device-coexistence.md) — Desconectar plataforma Business por coexistência

### [Administração](./administracao/index.md)

- [`POST /instance/create`](./administracao/post-instance-create.md) — Criar instância
- [`GET /instance/all`](./administracao/get-instance-all.md) — Listar todas as instâncias
- [`POST /instance/updateAdminFields`](./administracao/post-instance-updateadminfields.md) — Atualizar campos administrativos
- [`GET /globalwebhook`](./administracao/get-globalwebhook.md) — Ver webhook global
- [`POST /globalwebhook`](./administracao/post-globalwebhook.md) — Configurar webhook global
- [`GET /globalwebhook/errors`](./administracao/get-globalwebhook-errors.md) — Ver erros do webhook global
- [`POST /admin/restart`](./administracao/post-admin-restart.md) — Agendar reinício das instâncias

### [Instancia](./instancia/index.md)

- [`POST /instance/connect`](./instancia/post-instance-connect.md) — Conectar instância ao WhatsApp
- [`POST /instance/disconnect`](./instancia/post-instance-disconnect.md) — Desconectar instância
- [`GET /instance/status`](./instancia/get-instance-status.md) — Verificar status da instância
- [`POST /instance/updateInstanceName`](./instancia/post-instance-updateinstancename.md) — Atualizar nome da instância
- [`DELETE /instance`](./instancia/delete-instance.md) — Deletar instância
- [`GET /instance/privacy`](./instancia/get-instance-privacy.md) — Buscar configurações de privacidade
- [`POST /instance/privacy`](./instancia/post-instance-privacy.md) — Alterar configurações de privacidade
- [`GET /instance/username`](./instancia/get-instance-username.md) — Obter @username
- [`POST /instance/username/check`](./instancia/post-instance-username-check.md) — Verificar disponibilidade de @username
- [`POST /instance/username`](./instancia/post-instance-username.md) — Definir @username
- [`DELETE /instance/username`](./instancia/delete-instance-username.md) — Remover @username
- [`POST /instance/username/pin`](./instancia/post-instance-username-pin.md) — Verificar PIN do @username
- [`GET /instance/account/email`](./instancia/get-instance-account-email.md) — Mobile - Obter e-mail da conta
- [`POST /instance/account/email`](./instancia/post-instance-account-email.md) — Mobile - Definir e-mail da conta
- [`POST /instance/account/email/verify`](./instancia/post-instance-account-email-verify.md) — Mobile - Solicitar verificação de e-mail
- [`POST /instance/account/email/confirm`](./instancia/post-instance-account-email-confirm.md) — Mobile - Confirmar código do e-mail
- [`GET /instance/account/2fa`](./instancia/get-instance-account-2fa.md) — Mobile - Obter status 2FA da conta
- [`POST /instance/account/2fa`](./instancia/post-instance-account-2fa.md) — Mobile - Definir/limpar PIN 2FA da conta
- [`POST /instance/account/accept_pay`](./instancia/post-instance-account-accept-pay.md) — Aceitar notice de pagamento
- [`GET /instance/disappearing_mode`](./instancia/get-instance-disappearing-mode.md) — Obter disappearing mode padrão
- [`POST /instance/disappearing_mode`](./instancia/post-instance-disappearing-mode.md) — Definir disappearing mode padrão
- [`POST /instance/presence`](./instancia/post-instance-presence.md) — Atualizar status de presença da instância
- [`GET /instance/mobile/verification-options`](./instancia/get-instance-mobile-verification-options.md) — Mobile - Consultar opções de verificação
- [`POST /instance/mobile/request-code`](./instancia/post-instance-mobile-request-code.md) — Mobile - Solicitar código de verificação
- [`POST /instance/mobile/verify-code`](./instancia/post-instance-mobile-verify-code.md) — Mobile - Verificar código de sincronização
- [`POST /instance/mobile/two-factor`](./instancia/post-instance-mobile-two-factor.md) — Mobile - Verificar PIN 2FA no registro
- [`POST /instance/mobile/two-factor/email`](./instancia/post-instance-mobile-two-factor-email.md) — Mobile - Solicitar OTP por e-mail (2FA)
- [`POST /instance/mobile/two-factor/email/verify`](./instancia/post-instance-mobile-two-factor-email-verify.md) — Mobile - Confirmar OTP do e-mail (2FA)
- [`POST /instance/mobile/two-factor/wipe`](./instancia/post-instance-mobile-two-factor-wipe.md) — Mobile - Wipe da conta (2FA)
- [`POST /instance/connect/migration`](./instancia/post-instance-connect-migration.md) — Conectar via migração de sessão
- [`POST /instance/reset`](./instancia/post-instance-reset.md) — Resetar instância
- [`GET /instance/passkey`](./instancia/get-instance-passkey.md) — Obter opções de passkey
- [`POST /instance/passkey`](./instancia/post-instance-passkey.md) — Enviar resposta de passkey
- [`POST /instance/passkey/confirm`](./instancia/post-instance-passkey-confirm.md) — Confirmar passkey
- [`POST /instance/mobile/verification-options`](./instancia/post-instance-mobile-verification-options.md) — Mobile - Sincronizar opções de verificação
- [`GET /instance/mobile/verification-waits`](./instancia/get-instance-mobile-verification-waits.md) — Mobile - Consultar espera de verificação
- [`GET /instance/mobile/registration-otp`](./instancia/get-instance-mobile-registration-otp.md) — Mobile - Obter OTP recente
- [`POST /instance/account/report`](./instancia/post-instance-account-report.md) — Denunciar conta (spam)
- [`GET /instance/account/pay/methods`](./instancia/get-instance-account-pay-methods.md) — Listar metodos de pagamento
- [`POST /instance/account/pay/custom-method`](./instancia/post-instance-account-pay-custom-method.md) — Criar metodo de pagamento custom
- [`POST /instance/account/pay/pix-key`](./instancia/post-instance-account-pay-pix-key.md) — Criar chave PIX (metodo de pagamento)
- [`GET /instance/account/reachout-timelock`](./instancia/get-instance-account-reachout-timelock.md) — Consultar bloqueio temporário de contato
- [`POST /instance/mobile/appeal`](./instancia/post-instance-mobile-appeal.md) — Mobile - Pedir análise do bloqueio (Ban Appeal)
- [`POST /instance/mobile/ban-status`](./instancia/post-instance-mobile-ban-status.md) — Mobile - Consultar status do bloqueio
- [`POST /instance/restore`](./instancia/post-instance-restore.md) — POST /instance/restore
- [`GET /instance/transcript/config`](./instancia/get-instance-transcript-config.md) — GET /instance/transcript/config
- [`POST /instance/transcript/config`](./instancia/post-instance-transcript-config.md) — POST /instance/transcript/config

### [Dispositivos (Mobile)](./dispositivos-mobile/index.md)

- [`GET /devices`](./dispositivos-mobile/get-devices.md) — Mobile - Listar dispositivos adicionais
- [`DELETE /devices`](./dispositivos-mobile/delete-devices.md) — Mobile - Desconectar dispositivo adicional
- [`POST /device/pair/qr`](./dispositivos-mobile/post-device-pair-qr.md) — Mobile - Vincular dispositivo via QR
- [`POST /device/pair/code`](./dispositivos-mobile/post-device-pair-code.md) — Mobile - Vincular dispositivo via paircode

### [CRM](./crm/index.md)

- [`POST /chat/editLead`](./crm/post-chat-editlead.md) — Editar informações de lead
- [`POST /instance/updateFieldsMap`](./crm/post-instance-updatefieldsmap.md) — Atualizar mapa de campos personalizados
- [`POST /chat/lead/attrs`](./crm/post-chat-lead-attrs.md) — Atualizar atributos personalizados do lead
- [`POST /chat/lead/stego`](./crm/post-chat-lead-stego.md) — Gerar link wa.me com tracking invisivel

### [Proxy](./proxy/index.md)

- [`GET /instance/proxy`](./proxy/get-instance-proxy.md) — Obter configuração de proxy
- [`POST /instance/proxy`](./proxy/post-instance-proxy.md) — Configurar proxy da instância
- [`DELETE /instance/proxy`](./proxy/delete-instance-proxy.md) — Remover proxy customizado
- [`GET /instance/proxy/check`](./proxy/get-instance-proxy-check.md) — Verificar IP de saída do proxy

### [Perfil](./perfil/index.md)

- [`POST /profile/name`](./perfil/post-profile-name.md) — Alterar nome do perfil
- [`POST /profile/image`](./perfil/post-profile-image.md) — Alterar imagem do perfil
- [`POST /profile/status`](./perfil/post-profile-status.md) — Alterar status (About) do perfil

### [Enviar Mensagem](./enviar-mensagem/index.md)

- [`POST /send/text`](./enviar-mensagem/post-send-text.md) — Enviar mensagem de texto
- [`POST /send/media`](./enviar-mensagem/post-send-media.md) — Enviar mídia
- [`POST /send/contact`](./enviar-mensagem/post-send-contact.md) — Enviar cartão de contato
- [`POST /send/location`](./enviar-mensagem/post-send-location.md) — Enviar localização
- [`POST /message/presence`](./enviar-mensagem/post-message-presence.md) — Enviar presença no chat
- [`POST /send/image`](./enviar-mensagem/post-send-image.md) — Enviar imagem
- [`POST /send/button`](./enviar-mensagem/post-send-button.md) — Enviar botões interativos
- [`POST /send/list`](./enviar-mensagem/post-send-list.md) — Enviar lista interativa
- [`POST /send/menu`](./enviar-mensagem/post-send-menu.md) — Enviar menu interativo
- [`POST /send/carousel`](./enviar-mensagem/post-send-carousel.md) — Enviar carrossel
- [`POST /send/location-button`](./enviar-mensagem/post-send-location-button.md) — Solicitar localização
- [`POST /send/request-payment`](./enviar-mensagem/post-send-request-payment.md) — Solicitar pagamento
- [`POST /send/pix-button`](./enviar-mensagem/post-send-pix-button.md) — Enviar botão PIX
- [`POST /send/rich`](./enviar-mensagem/post-send-rich.md) — Enviar mensagem rica (AI rich)
- [`POST /send/table`](./enviar-mensagem/post-send-table.md) — Enviar tabela
- [`POST /send/code-block`](./enviar-mensagem/post-send-code-block.md) — Enviar bloco de código
- [`POST /send/latex`](./enviar-mensagem/post-send-latex.md) — Enviar LaTeX / fórmula
- [`POST /send/sticker`](./enviar-mensagem/post-send-sticker.md) — Enviar figurinha
- [`POST /send/sticker-pack`](./enviar-mensagem/post-send-sticker-pack.md) — Enviar pack de figurinhas
- [`POST /send/event`](./enviar-mensagem/post-send-event.md) — Enviar evento / convite
- [`POST /send/event-response`](./enviar-mensagem/post-send-event-response.md) — Responder convite de evento (RSVP)
- [`POST /send/poll`](./enviar-mensagem/post-send-poll.md) — Enviar enquete
- [`POST /send/comment`](./enviar-mensagem/post-send-comment.md) — Comentar em uma mensagem
- [`POST /send/payment-request`](./enviar-mensagem/post-send-payment-request.md) — Enviar botão de pagamento
- [`POST /send/album`](./enviar-mensagem/post-send-album.md) — Enviar álbum de imagens
- [`POST /send/product`](./enviar-mensagem/post-send-product.md) — Enviar mensagem de produto
- [`POST /send/music`](./enviar-mensagem/post-send-music.md) — Enviar mensagem de música
- [`POST /send/call-link`](./enviar-mensagem/post-send-call-link.md) — Enviar link de chamada
- [`POST /send/meta-ai`](./enviar-mensagem/post-send-meta-ai.md) — Enviar prompt Meta AI
- [`POST /send/shop`](./enviar-mensagem/post-send-shop.md) — POST /send/shop
- [`POST /send/collection`](./enviar-mensagem/post-send-collection.md) — POST /send/collection
- [`POST /message/revoke`](./enviar-mensagem/post-message-revoke.md) — Revogar mensagem (apagar para todos)

### [Mensagem Async](./mensagem-async/index.md)

- [`GET /message/async`](./mensagem-async/get-message-async.md) — Consultar fila de envio assíncrono
- [`DELETE /message/async`](./mensagem-async/delete-message-async.md) — Limpar fila de envio assíncrono
- [`POST /instance/updateDelaySettings`](./mensagem-async/post-instance-updatedelaysettings.md) — Configurar delay entre mensagens async

### [Ações na mensagem e Buscar](./acoes-na-mensagem-e-buscar/index.md)

- [`POST /message/download`](./acoes-na-mensagem-e-buscar/post-message-download.md) — Baixar mídia de uma mensagem
- [`POST /message/find`](./acoes-na-mensagem-e-buscar/post-message-find.md) — Buscar mensagens no histórico
- [`POST /message/history-sync`](./acoes-na-mensagem-e-buscar/post-message-history-sync.md) — Solicitar histórico sob demanda
- [`POST /message/markread`](./acoes-na-mensagem-e-buscar/post-message-markread.md) — Marcar mensagens como lidas
- [`POST /message/react`](./acoes-na-mensagem-e-buscar/post-message-react.md) — Reagir a uma mensagem
- [`POST /message/delete`](./acoes-na-mensagem-e-buscar/post-message-delete.md) — Apagar mensagem para todos
- [`POST /message/edit`](./acoes-na-mensagem-e-buscar/post-message-edit.md) — Editar mensagem enviada
- [`POST /message/pin`](./acoes-na-mensagem-e-buscar/post-message-pin.md) — Fixar ou desafixar mensagem
- [`GET /media/{{instanceID}}/{{messageID}}`](./acoes-na-mensagem-e-buscar/get-media-instanceid-messageid.md) — Servir mídia temporária
- [`POST /message/delete-for-me`](./acoes-na-mensagem-e-buscar/post-message-delete-for-me.md) — Apagar mensagem só para mim
- [`POST /message/star`](./acoes-na-mensagem-e-buscar/post-message-star.md) — Favoritar ou desfavoritar mensagem
- [`POST /message/poll-vote`](./acoes-na-mensagem-e-buscar/post-message-poll-vote.md) — Votar em enquete
- [`POST /media/newsletter-upload`](./acoes-na-mensagem-e-buscar/post-media-newsletter-upload.md) — Enviar mídia para o canal

### [Grupos e Comunidades](./grupos-e-comunidades/index.md)

- [`POST /group/create`](./grupos-e-comunidades/post-group-create.md) — Criar um novo grupo
- [`POST /group/info`](./grupos-e-comunidades/post-group-info.md) — Obter informações detalhadas de um grupo
- [`POST /group/inviteInfo`](./grupos-e-comunidades/post-group-inviteinfo.md) — Obter informações de um grupo pelo código de convite
- [`POST /group/join`](./grupos-e-comunidades/post-group-join.md) — Entrar em um grupo usando código de convite
- [`POST /group/leave`](./grupos-e-comunidades/post-group-leave.md) — Sair de um grupo
- [`POST /group/member-label`](./grupos-e-comunidades/post-group-member-label.md) — Definir etiqueta de membro do grupo
- [`GET /group/list`](./grupos-e-comunidades/get-group-list.md) — Listar todos os grupos
- [`POST /group/resetInviteCode`](./grupos-e-comunidades/post-group-resetinvitecode.md) — Resetar código de convite do grupo
- [`POST /group/updateAnnounce`](./grupos-e-comunidades/post-group-updateannounce.md) — Configurar permissões de envio de mensagens no grupo
- [`POST /group/updateJoinApproval`](./grupos-e-comunidades/post-group-updatejoinapproval.md) — Configurar aprovação para entrada no grupo
- [`POST /group/updateMemberAddMode`](./grupos-e-comunidades/post-group-updatememberaddmode.md) — Configurar quem pode adicionar novos membros ao grupo
- [`POST /group/updateDescription`](./grupos-e-comunidades/post-group-updatedescription.md) — Atualizar descrição do grupo
- [`POST /group/ephemeral`](./grupos-e-comunidades/post-group-ephemeral.md) — Configurar mensagens temporárias em grupo
- [`POST /group/updateImage`](./grupos-e-comunidades/post-group-updateimage.md) — Atualizar imagem do grupo
- [`POST /group/updateTopic`](./grupos-e-comunidades/post-group-updatetopic.md) — Atualizar tópico do grupo
- [`POST /group/updateLocked`](./grupos-e-comunidades/post-group-updatelocked.md) — Configurar permissão de edição do grupo
- [`POST /group/updateName`](./grupos-e-comunidades/post-group-updatename.md) — Atualizar nome do grupo
- [`POST /group/updateParticipants`](./grupos-e-comunidades/post-group-updateparticipants.md) — Gerenciar participantes do grupo
- [`POST /group/join-requests`](./grupos-e-comunidades/post-group-join-requests.md) — Listar pedidos de entrada no grupo
- [`POST /group/join-requests/update`](./grupos-e-comunidades/post-group-join-requests-update.md) — Aprovar ou rejeitar pedidos de entrada
- [`POST /community/create`](./grupos-e-comunidades/post-community-create.md) — Criar uma comunidade
- [`POST /community/editgroups`](./grupos-e-comunidades/post-community-editgroups.md) — Gerenciar grupos em uma comunidade
- [`POST /community/subgroups`](./grupos-e-comunidades/post-community-subgroups.md) — Listar subgrupos da comunidade
- [`POST /community/owner/transfer`](./grupos-e-comunidades/post-community-owner-transfer.md) — Transferir propriedade da comunidade
- [`POST /group/invite-info`](./grupos-e-comunidades/post-group-invite-info.md) — Obter informações de grupo via convite
- [`POST /group/invite-join`](./grupos-e-comunidades/post-group-invite-join.md) — Entrar em grupo via mensagem de convite
- [`POST /group/linked-participants`](./grupos-e-comunidades/post-group-linked-participants.md) — Listar participantes de grupos vinculados
- [`POST /group/ack`](./grupos-e-comunidades/post-group-ack.md) — Confirmar (ack) estado de grupo
- [`POST /group/invite-sms`](./grupos-e-comunidades/post-group-invite-sms.md) — Convidar participantes por SMS
- [`POST /group/invite-sms/send`](./grupos-e-comunidades/post-group-invite-sms-send.md) — Convidar participantes por SMS (registrar e enviar)
- [`POST /group/growth-invite`](./grupos-e-comunidades/post-group-growth-invite.md) — Criar convite de crescimento de grupo
- [`POST /group/send-history`](./grupos-e-comunidades/post-group-send-history.md) — Compartilhar histórico do grupo com novos membros

### [Newsletters e Canais](./newsletters-e-canais/index.md)

- [`POST /newsletter/create`](./newsletters-e-canais/post-newsletter-create.md) — Criar canal
- [`GET /newsletter/list`](./newsletters-e-canais/get-newsletter-list.md) — Listar canais seguidos
- [`POST /newsletter/info`](./newsletters-e-canais/post-newsletter-info.md) — Consultar informações do canal
- [`POST /newsletter/link`](./newsletters-e-canais/post-newsletter-link.md) — Consultar canal por convite
- [`POST /newsletter/subscribe`](./newsletters-e-canais/post-newsletter-subscribe.md) — Assinar atualizações temporárias do canal
- [`POST /newsletter/messages`](./newsletters-e-canais/post-newsletter-messages.md) — Listar mensagens do canal
- [`POST /newsletter/messages/edit`](./newsletters-e-canais/post-newsletter-messages-edit.md) — Editar mensagem do canal
- [`POST /newsletter/messages/delete`](./newsletters-e-canais/post-newsletter-messages-delete.md) — Excluir mensagem do canal
- [`POST /newsletter/updates`](./newsletters-e-canais/post-newsletter-updates.md) — Buscar atualizações de mensagens
- [`POST /newsletter/viewed`](./newsletters-e-canais/post-newsletter-viewed.md) — Marcar mensagens como visualizadas
- [`POST /newsletter/reaction`](./newsletters-e-canais/post-newsletter-reaction.md) — Reagir a uma mensagem do canal
- [`POST /newsletter/follow`](./newsletters-e-canais/post-newsletter-follow.md) — Seguir canal
- [`POST /newsletter/unfollow`](./newsletters-e-canais/post-newsletter-unfollow.md) — Deixar de seguir canal
- [`POST /newsletter/mute`](./newsletters-e-canais/post-newsletter-mute.md) — Silenciar notificações do canal
- [`POST /newsletter/unmute`](./newsletters-e-canais/post-newsletter-unmute.md) — Reativar notificações do canal
- [`POST /newsletter/delete`](./newsletters-e-canais/post-newsletter-delete.md) — Sair do canal
- [`POST /newsletter/picture`](./newsletters-e-canais/post-newsletter-picture.md) — Atualizar foto do canal
- [`POST /newsletter/name`](./newsletters-e-canais/post-newsletter-name.md) — Atualizar nome do canal
- [`POST /newsletter/description`](./newsletters-e-canais/post-newsletter-description.md) — Atualizar descrição do canal
- [`POST /newsletter/settings`](./newsletters-e-canais/post-newsletter-settings.md) — Atualizar configurações do canal
- [`POST /newsletter/search`](./newsletters-e-canais/post-newsletter-search.md) — Pesquisar e descobrir canais
- [`POST /newsletter/admin/invite`](./newsletters-e-canais/post-newsletter-admin-invite.md) — Convidar administrador do canal
- [`POST /newsletter/admin/accept`](./newsletters-e-canais/post-newsletter-admin-accept.md) — Aceitar convite de administrador
- [`POST /newsletter/admin/remove`](./newsletters-e-canais/post-newsletter-admin-remove.md) — Remover administrador do canal
- [`POST /newsletter/admin/revoke`](./newsletters-e-canais/post-newsletter-admin-revoke.md) — Revogar convite de administrador
- [`POST /newsletter/owner/transfer`](./newsletters-e-canais/post-newsletter-owner-transfer.md) — Transferir propriedade do canal
- [`POST /newsletter/statuses`](./newsletters-e-canais/post-newsletter-statuses.md) — Listar status do canal
- [`POST /newsletter/enforcements`](./newsletters-e-canais/post-newsletter-enforcements.md) — Obter enforcements do canal
- [`POST /newsletter/insights`](./newsletters-e-canais/post-newsletter-insights.md) — Obter métricas do canal (insights)
- [`POST /newsletter/poll-voters`](./newsletters-e-canais/post-newsletter-poll-voters.md) — Listar votantes de enquete do canal
- [`POST /newsletter/reaction-senders`](./newsletters-e-canais/post-newsletter-reaction-senders.md) — Listar quem reagiu à mensagem do canal
- [`POST /newsletter/my-addons`](./newsletters-e-canais/post-newsletter-my-addons.md) — Listar add-ons do canal
- [`POST /newsletter/tos`](./newsletters-e-canais/post-newsletter-tos.md) — Aceitar termos de uso do canal
- [`POST /newsletter/destroy`](./newsletters-e-canais/post-newsletter-destroy.md) — Excluir canal (owner)
- [`POST /newsletter/followers`](./newsletters-e-canais/post-newsletter-followers.md) — Listar seguidores do canal
- [`POST /newsletter/link-preview`](./newsletters-e-canais/post-newsletter-link-preview.md) — Preview de link para o canal
- [`POST /newsletter/message-integrity`](./newsletters-e-canais/post-newsletter-message-integrity.md) — Checar integridade de URLs do post
- [`POST /newsletter/directory/categories`](./newsletters-e-canais/post-newsletter-directory-categories.md) — Diretório: prévia por categorias
- [`POST /newsletter/directory/list`](./newsletters-e-canais/post-newsletter-directory-list.md) — Diretório: listar canais
- [`POST /newsletter/similar`](./newsletters-e-canais/post-newsletter-similar.md) — Canais similares
- [`POST /newsletter/messages/pin`](./newsletters-e-canais/post-newsletter-messages-pin.md) — Fixar mensagens do canal
- [`POST /newsletter/messages/unpin`](./newsletters-e-canais/post-newsletter-messages-unpin.md) — Desfixar mensagens do canal
- [`POST /newsletter/messages/label-ai`](./newsletters-e-canais/post-newsletter-messages-label-ai.md) — Rotular mensagem como conteúdo gerado por IA
- [`POST /newsletter/messages/paid-partnership`](./newsletters-e-canais/post-newsletter-messages-paid-partnership.md) — Rotular mensagem como parceria paga

### [Webhooks e SSE](./webhooks-e-sse/index.md)

- [`GET /webhook`](./webhooks-e-sse/get-webhook.md) — Ver webhook da instância
- [`POST /webhook`](./webhooks-e-sse/post-webhook.md) — Configurar webhook da instância
- [`GET /webhook/errors`](./webhooks-e-sse/get-webhook-errors.md) — Ver erros do webhook da instância
- [`GET /sse`](./webhooks-e-sse/get-sse.md) — Receber eventos via SSE

### [Bloqueios](./bloqueios/index.md)

- [`POST /chat/block`](./bloqueios/post-chat-block.md) — Bloquear ou desbloquear contato
- [`GET /chat/blocklist`](./bloqueios/get-chat-blocklist.md) — Listar contatos bloqueados
- [`POST /blocklist/dhash`](./bloqueios/post-blocklist-dhash.md) — Sincronizar lista de bloqueio (dhash)

### [Etiquetas](./etiquetas/index.md)

- [`POST /chat/labels`](./etiquetas/post-chat-labels.md) — Definir etiquetas de um chat
- [`POST /label/edit`](./etiquetas/post-label-edit.md) — Criar, editar ou remover etiqueta
- [`GET /labels`](./etiquetas/get-labels.md) — Listar etiquetas
- [`POST /labels/refresh`](./etiquetas/post-labels-refresh.md) — Atualizar etiquetas do WhatsApp

### [Chats](./chats/index.md)

- [`POST /chat/delete`](./chats/post-chat-delete.md) — Excluir chat
- [`POST /chat/archive`](./chats/post-chat-archive.md) — Arquivar ou desarquivar chat
- [`POST /chat/ephemeral`](./chats/post-chat-ephemeral.md) — Configurar mensagens temporárias do chat
- [`POST /chat/read`](./chats/post-chat-read.md) — Marcar chat como lido ou não lido
- [`POST /chat/mute`](./chats/post-chat-mute.md) — Silenciar ou reativar notificações do chat
- [`POST /chat/pin`](./chats/post-chat-pin.md) — Fixar ou desafixar chat
- [`POST /chat/find`](./chats/post-chat-find.md) — Listar chats recentes
- [`POST /chat/notes`](./chats/post-chat-notes.md) — Consultar notas do chat
- [`POST /chat/notes/refresh`](./chats/post-chat-notes-refresh.md) — Recarregar notas do chat
- [`POST /chat/notes/edit`](./chats/post-chat-notes-edit.md) — Editar notas do chat
- [`POST /chat/sync`](./chats/post-chat-sync.md) — Sincronizar chats e mensagens
- [`POST /chat/capping`](./chats/post-chat-capping.md) — Obter capping de novo chat

### [Contatos](./contatos/index.md)

- [`GET /contacts`](./contatos/get-contacts.md) — Listar contatos
- [`POST /contacts/list`](./contatos/post-contacts-list.md) — Listar contatos com paginação
- [`POST /contacts/sync`](./contatos/post-contacts-sync.md) — Mobile - Sincronizar agenda
- [`POST /contact/add`](./contatos/post-contact-add.md) — Adicionar contato à agenda
- [`POST /contact/remove`](./contatos/post-contact-remove.md) — Remover contato da agenda
- [`POST /chat/details`](./contatos/post-chat-details.md) — Obter detalhes do chat
- [`POST /chat/check`](./contatos/post-chat-check.md) — Verificar números no WhatsApp
- [`POST /contact/picture`](./contatos/post-contact-picture.md) — Obter foto de perfil do contato
- [`POST /contact/edit`](./contatos/post-contact-edit.md) — Editar ou criar contato
- [`POST /contact/presence`](./contatos/post-contact-presence.md) — Consultar presença do contato

### [Respostas Rápidas](./respostas-rapidas/index.md)

- [`POST /quickreply/edit`](./respostas-rapidas/post-quickreply-edit.md) — Criar ou atualizar resposta rápida
- [`GET /quickreply/showall`](./respostas-rapidas/get-quickreply-showall.md) — Listar respostas rápidas

### [Chamadas](./chamadas/index.md)

- [`POST /call/make`](./chamadas/post-call-make.md) — Iniciar chamada
- [`POST /call/accept`](./chamadas/post-call-accept.md) — Aceitar chamada
- [`POST /call/reject`](./chamadas/post-call-reject.md) — Rejeitar chamada
- [`POST /call/end`](./chamadas/post-call-end.md) — Encerrar chamada
- [`POST /call/video/upgrade`](./chamadas/post-call-video-upgrade.md) — Ativar vídeo na chamada
- [`POST /call/webrtc`](./chamadas/post-call-webrtc.md) — Trocar SDP WebRTC
- [`GET /call/status`](./chamadas/get-call-status.md) — Listar chamadas ativas
- [`POST /call/link/create`](./chamadas/post-call-link-create.md) — Criar link de chamada
- [`POST /call/link/waiting-room`](./chamadas/post-call-link-waiting-room.md) — Configurar sala de espera do link
- [`GET /call/history`](./chamadas/get-call-history.md) — Listar histórico de chamadas
- [`GET /call/history/{{call_id}}`](./chamadas/get-call-history-call-id.md) — Obter chamada do histórico
- [`GET /call/history/{{call_id}}/recording/url`](./chamadas/get-call-history-call-id-recording-url.md) — URL de reprodução/download da gravação
- [`DELETE /call/history/{{call_id}}/recording`](./chamadas/delete-call-history-call-id-recording.md) — Excluir gravação de chamada
- [`POST /call/sip/enable`](./chamadas/post-call-sip-enable.md) — Habilitar conta SIP
- [`GET /call/sip`](./chamadas/get-call-sip.md) — Status da conta SIP
- [`POST /call/sip/rotate`](./chamadas/post-call-sip-rotate.md) — Rotacionar senha SIP
- [`DELETE /call/sip`](./chamadas/delete-call-sip.md) — Desabilitar conta SIP
- [`GET /call/pcm`](./chamadas/get-call-pcm.md) — WebSocket PCM (áudio operador)
- [`GET /call/video`](./chamadas/get-call-video.md) — WebSocket H264 (vídeo peer)
- [`GET /call`](./chamadas/get-call.md) — Abrir interface de chamada
- [`POST /call/screen-share`](./chamadas/post-call-screen-share.md) — Ativar ou desativar compartilhamento de tela
- [`GET /call/styles.css`](./chamadas/get-call-styles-css.md) — Carregar estilos da chamada
- [`GET /call/favicon.svg`](./chamadas/get-call-favicon-svg.md) — Carregar ícone da chamada
- [`GET /call/app.js`](./chamadas/get-call-app-js.md) — Carregar aplicação da chamada
- [`GET /call/h264-decoder.js`](./chamadas/get-call-h264-decoder-js.md) — Carregar decodificador H264
- [`GET /call/worklets/{{filepath}}`](./chamadas/get-call-worklets-filepath.md) — Carregar worklet de áudio da chamada
- [`GET /call.js`](./chamadas/get-call-js.md) — Carregar script da chamada

### [Integração Chatwoot](./integracao-chatwoot/index.md)

- [`GET /chatwoot/call/resolve`](./integracao-chatwoot/get-chatwoot-call-resolve.md) — Resolver widget de chamada Chatwoot
- [`GET /chatwoot/config`](./integracao-chatwoot/get-chatwoot-config.md) — Obter configuração do Chatwoot
- [`PUT /chatwoot/config`](./integracao-chatwoot/put-chatwoot-config.md) — Atualizar configuração do Chatwoot
- [`GET /chatwoot/sync/status`](./integracao-chatwoot/get-chatwoot-sync-status.md) — Status da sincronização Chatwoot
- [`POST /chatwoot/webhook`](./integracao-chatwoot/post-chatwoot-webhook.md) — Webhook Chatwoot

### [Business](./business/index.md)

- [`POST /business/get/profile`](./business/post-business-get-profile.md) — Obter perfil comercial
- [`GET /business/get/categories`](./business/get-business-get-categories.md) — Obter categorias de negócios
- [`POST /business/update/profile`](./business/post-business-update-profile.md) — Atualizar perfil comercial
- [`POST /business/get/features`](./business/post-business-get-features.md) — Mobile - Obter features Business
- [`POST /business/get/mobile_config`](./business/post-business-get-mobile-config.md) — Mobile - Obter configuração mobile da conta Business
- [`POST /business/get/verified_name`](./business/post-business-get-verified-name.md) — Mobile - Obter verified name
- [`POST /business/update/verified_name`](./business/post-business-update-verified-name.md) — Mobile - Atualizar verified name
- [`POST /business/catalog/list`](./business/post-business-catalog-list.md) — Listar produtos do catálogo WhatsApp
- [`POST /business/catalog/info`](./business/post-business-catalog-info.md) — Obter produto do catálogo WhatsApp
- [`POST /business/catalog/delete`](./business/post-business-catalog-delete.md) — Excluir produto do catálogo WhatsApp
- [`POST /business/catalog/show`](./business/post-business-catalog-show.md) — Exibir produto no catálogo
- [`POST /business/catalog/hide`](./business/post-business-catalog-hide.md) — Ocultar produto no catálogo
- [`POST /business/catalog/product`](./business/post-business-catalog-product.md) — Cadastrar produto local do catálogo
- [`GET /business/catalog/products`](./business/get-business-catalog-products.md) — Listar produtos locais do catálogo
- [`DELETE /business/catalog/product/{{id}}`](./business/delete-business-catalog-product-id.md) — Remover produto local do catálogo
- [`POST /business/get/privacy`](./business/post-business-get-privacy.md) — Obter privacy Business
- [`POST /biz/trade-nonce`](./business/post-biz-trade-nonce.md) — Trocar nonce por token de acesso Business
- [`POST /biz/profile/fields`](./business/post-biz-profile-fields.md) — Atualizar campos do perfil Business
- [`POST /biz/mobile/address`](./business/post-biz-mobile-address.md) — Atualizar endereço Business (mobile)
- [`POST /biz/mobile/categories`](./business/post-biz-mobile-categories.md) — Atualizar categorias Business (mobile)
- [`POST /biz/cover`](./business/post-biz-cover.md) — Atualizar foto de capa Business
- [`POST /biz/mobile/description`](./business/post-biz-mobile-description.md) — Atualizar descrição Business (mobile)
- [`POST /biz/mobile/email`](./business/post-biz-mobile-email.md) — Atualizar e-mail Business (mobile)
- [`POST /biz/mobile/hours`](./business/post-biz-mobile-hours.md) — Atualizar horário de funcionamento Business (mobile)
- [`POST /biz/mobile/offerings`](./business/post-biz-mobile-offerings.md) — Atualizar ofertas do catálogo Business (mobile)
- [`POST /biz/mobile/websites`](./business/post-biz-mobile-websites.md) — Atualizar sites Business (mobile)
- [`POST /biz/mobile/profile-delta`](./business/post-biz-mobile-profile-delta.md) — Atualizar delta de perfil Business (mobile)
- [`DELETE /biz/cover`](./business/delete-biz-cover.md) — Remover foto de capa Business
- [`POST /biz/mobile/cover`](./business/post-biz-mobile-cover.md) — Atualizar foto de capa Business
- [`DELETE /biz/mobile/cover`](./business/delete-biz-mobile-cover.md) — Remover foto de capa Business

### [Auto-Reply](./auto-reply/index.md)

- [`POST /auto-reply/rule`](./auto-reply/post-auto-reply-rule.md) — Criar regra de auto-resposta
- [`GET /auto-reply/rules`](./auto-reply/get-auto-reply-rules.md) — Listar regras de auto-resposta
- [`GET /auto-reply/rule/{{id}}`](./auto-reply/get-auto-reply-rule-id.md) — Obter regra de auto-resposta
- [`PUT /auto-reply/rule/{{id}}`](./auto-reply/put-auto-reply-rule-id.md) — Atualizar regra de auto-resposta
- [`DELETE /auto-reply/rule/{{id}}`](./auto-reply/delete-auto-reply-rule-id.md) — Excluir regra de auto-resposta
- [`POST /auto-reply/rule/{{id}}/toggle`](./auto-reply/post-auto-reply-rule-id-toggle.md) — Ativar/desativar regra
- [`GET /auto-reply/settings`](./auto-reply/get-auto-reply-settings.md) — Obter configurações de auto-resposta
- [`POST /auto-reply/settings`](./auto-reply/post-auto-reply-settings.md) — Atualizar configurações de auto-resposta

### [Scheduler](./scheduler/index.md)

- [`POST /scheduler/schedule`](./scheduler/post-scheduler-schedule.md) — Agendar mensagem para horário específico
- [`POST /scheduler/delay`](./scheduler/post-scheduler-delay.md) — Agendar mensagem com delay
- [`GET /scheduler/pending`](./scheduler/get-scheduler-pending.md) — Listar mensagens pendentes
- [`DELETE /scheduler/{{id}}`](./scheduler/delete-scheduler-id.md) — Cancelar mensagem agendada
- [`DELETE /scheduler/cancel-all`](./scheduler/delete-scheduler-cancel-all.md) — Cancelar todas as mensagens pendentes
- [`POST /scheduler/pause`](./scheduler/post-scheduler-pause.md) — Pausar scheduler da instância
- [`POST /scheduler/resume`](./scheduler/post-scheduler-resume.md) — Retomar scheduler da instância

### [Anti-Delete](./anti-delete/index.md)

- [`GET /anti-delete/config`](./anti-delete/get-anti-delete-config.md) — Obter configuração anti-delete
- [`POST /anti-delete/config`](./anti-delete/post-anti-delete-config.md) — Atualizar configuração anti-delete
- [`GET /anti-delete/recovered`](./anti-delete/get-anti-delete-recovered.md) — Listar mensagens recuperadas
- [`GET /anti-delete/recovered/{{id}}`](./anti-delete/get-anti-delete-recovered-id.md) — Obter mensagem recuperada
- [`DELETE /anti-delete/recovered/{{id}}`](./anti-delete/delete-anti-delete-recovered-id.md) — Remover mensagem recuperada

### [STATUS](./status/index.md)

- [`GET /status/privacy`](./status/get-status-privacy.md) — Obter configurações de privacidade do status
- [`POST /status/privacy`](./status/post-status-privacy.md) — Definir privacidade do status
- [`GET /status/presets`](./status/get-status-presets.md) — Listar presets de backgrounds e fonts
- [`POST /status/text`](./status/post-status-text.md) — Mobile - Publicar status de texto
- [`POST /send/status`](./status/post-send-status.md) — Enviar status (stories)
- [`POST /send/group-status`](./status/post-send-group-status.md) — Enviar status de grupo
- [`DELETE /send/group-status`](./status/delete-send-group-status.md) — Apagar status de grupo
- [`POST /send/channel-status`](./status/post-send-channel-status.md) — Enviar status de canal
- [`POST /status/mention-audience`](./status/post-status-mention-audience.md) — Expandir audiência de menção em status
- [`POST /status/mention-notify`](./status/post-status-mention-notify.md) — Notificar menção em status
- [`POST /status/privacy-list`](./status/post-status-privacy-list.md) — Definir lista de privacidade de status

### [Admininstração](./admininstracao/index.md)

- [`DELETE /instance/admin`](./admininstracao/delete-instance-admin.md) — Deletar instancia

### [Usuários](./usuarios/index.md)

- [`POST /user/mex/fetch`](./usuarios/post-user-mex-fetch.md) — Buscar usuários (MEX)
- [`POST /user/mex/about`](./usuarios/post-user-mex-about.md) — Obter recado (about) do usuário
- [`POST /user/mex/text-status-list`](./usuarios/post-user-mex-text-status-list.md) — Listar status de texto do usuário
- [`POST /user/username/find`](./usuarios/post-user-username-find.md) — Buscar usuário por username
- [`POST /user/username/fetch`](./usuarios/post-user-username-fetch.md) — Buscar usernames de contatos
- [`POST /user/username/check`](./usuarios/post-user-username-check.md) — Verificar disponibilidade de username
- [`POST /user/username/linked-alias`](./usuarios/post-user-username-linked-alias.md) — Obter alias vinculado ao username
- [`POST /user/pkicrl`](./usuarios/post-user-pkicrl.md) — Obter CRL do PKI

### [Privacidade](./privacidade/index.md)

- [`POST /privacy/settings`](./privacidade/post-privacy-settings.md) — Obter configurações de privacidade

### [Links](./links/index.md)

- [`POST /link/business-message`](./links/post-link-business-message.md) — Resolver link de mensagem Business
- [`POST /link/contact-qr`](./links/post-link-contact-qr.md) — Resolver QR code de contato
- [`POST /link/contact-qr/get`](./links/post-link-contact-qr-get.md) — Obter QR code de contato da conta

### [Bots](./bots/index.md)

- [`POST /bots/profiles`](./bots/post-bots-profiles.md) — Obter perfis detalhados de bots
- [`GET /bots`](./bots/get-bots.md) — Listar bots (Meta AI)
- [`POST /agents`](./bots/post-agents.md) — Criar agente de terceiros
- [`POST /agents/{{id}}/rotate-key`](./bots/post-agents-id-rotate-key.md) — Rotacionar chave do agente
- [`DELETE /agents/{{id}}`](./bots/delete-agents-id.md) — Excluir agente de terceiros
- [`PUT /agents/{{id}}`](./bots/put-agents-id.md) — Atualizar perfil do agente
- [`GET /agents/{{id}}`](./bots/get-agents-id.md) — Obter perfil do agente
- [`GET /agents`](./bots/get-agents.md) — Listar agentes de terceiros