NODAPI

Ações na mensagem e Buscar

Fixa ou desafixa uma mensagem

POST/message/pin

Autenticação: envie a chave da conexão no header token ou em Authorization: Bearer.

Fixa ou desafixa uma mensagem específica usando a funcionalidade nativa do WhatsApp.

O endpoint realiza:

  • Busca a mensagem original no banco de dados usando o ID fornecido
  • Envia a ação de fixar ou desafixar a mensagem no WhatsApp
  • Funciona em conversas individuais e grupos
  • Gera um novo ID para o evento de pin/unpin
  • Retorna objeto de mensagem completo seguindo o padrão da API
  • Dispara eventos SSE/Webhook automaticamente

Importante:

  • O ID pode ser fornecido no formato completo (owner:messageid) ou apenas messageid
  • Em conversas 1:1, a ação é suportada normalmente
  • Em grupos, a permissão depende da configuração do WhatsApp do grupo (apenas admins ou qualquer membro)
  • O backend não valida localmente se a instância é admin do grupo; a decisão final é do WhatsApp
  • Newsletters/canais não são suportados neste endpoint
  • Se pin não for enviado, o valor padrão é true
  • Ao fixar mensagem, duration aceita dias (1, 7 ou 30)
  • Se duration não for enviado ou vier com qualquer outro valor, o backend usa 30 dias
  • Ao desafixar (pin: false), duration é ignorado

Corpo da requisição (JSON)

CampoTipoDescrição
id*string

ID único da mensagem alvo (formato owner:messageid ou apenas messageid)

Exemplo: 3A12345678901234567890123456789012

pinboolean

Define se a mensagem deve ser fixada (true) ou desafixada (false)

Exemplo: true

durationinteger

Duração do pin em dias. Valores aceitos: 1, 7 ou 30. Qualquer outro valor cai para 30.

Exemplo: 7

* obrigatório

Exemplos de corpo

Fixar mensagem

{
  "id": "3A12345678901234567890123456789012",
  "pin": true,
  "duration": 7
}

Fixar mensagem com fallback para 30 dias

{
  "id": "3A12345678901234567890123456789012",
  "pin": true,
  "duration": 99
}

Desafixar mensagem

{
  "id": "3A12345678901234567890123456789012",
  "pin": false
}

Respostas

  • 200Ação de fixar/desafixar mensagem enviada com sucesso
  • 400Dados inválidos na requisição ou operação não suportada
  • 401Sem sessão ativa ou token inválido
  • 404Mensagem não encontrada
  • 500Erro interno do servidor ou erro retornado pelo WhatsApp

Experimente

Atenção: a chamada é real. Ela roda na sua conexão e pode enviar mensagem de verdade. A chave fica só nesta tela e some ao sair dela; nunca é guardada.

Cole a chave gerada no painel.