curl --request POST \
--url https://api.wppfy.com/message/pin \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"id": "3A12345678901234567890123456789012",
"pin": true,
"duration": 7
}
'{
"id": "5511999999999:3A12345678901234567890123456789012",
"messageid": "3A12345678901234567890123456789012",
"chatid": "120363123456789012@g.us",
"sender": "5511999999999@s.whatsapp.net",
"senderName": "Minha Instância",
"isGroup": true,
"fromMe": true,
"content": {},
"messageType": "PinInChatMessage",
"source": "web",
"messageTimestamp": 1704067200000,
"status": "Pending",
"text": "Mensagem fixada",
"quoted": "",
"edited": "",
"reaction": "",
"convertOptions": "",
"owner": "5511999999999",
"targetMessageID": "3EB0538DA65A59F6D8A251",
"pinned": true
}{
"error": "message pinning is not supported for newsletters"
}{
"error": "No session"
}{
"error": "Message not found"
}{
"error": "error pinning message: ..."
}Fixa ou desafixa uma mensagem
Fixa ou desafixa uma mensagem específica usando a funcionalidade nativa do WhatsApp.
Use esta operação para destacar uma mensagem importante em uma conversa individual ou grupo. A resposta registra a ação e ela também aparece nos eventos configurados.
Importante:
- O ID pode ser fornecido no formato completo retornado pela API ou apenas como
messageid - Em conversas
1:1, a ação é suportada normalmente - Em grupos, a permissão depende da configuração do WhatsApp do grupo (
apenas adminsouqualquer membro) - Em grupos, a permissão final depende das configurações do próprio grupo
- Newsletters/canais não são suportados neste endpoint
- Se
pinnão for enviado, o valor padrão étrue - Ao fixar mensagem,
durationaceita dias (1,7ou30) - Se
durationnão for enviado ou vier com qualquer outro valor, a API usa30dias - Ao desafixar (
pin: false),durationé ignorado
curl --request POST \
--url https://api.wppfy.com/message/pin \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"id": "3A12345678901234567890123456789012",
"pin": true,
"duration": 7
}
'{
"id": "5511999999999:3A12345678901234567890123456789012",
"messageid": "3A12345678901234567890123456789012",
"chatid": "120363123456789012@g.us",
"sender": "5511999999999@s.whatsapp.net",
"senderName": "Minha Instância",
"isGroup": true,
"fromMe": true,
"content": {},
"messageType": "PinInChatMessage",
"source": "web",
"messageTimestamp": 1704067200000,
"status": "Pending",
"text": "Mensagem fixada",
"quoted": "",
"edited": "",
"reaction": "",
"convertOptions": "",
"owner": "5511999999999",
"targetMessageID": "3EB0538DA65A59F6D8A251",
"pinned": true
}{
"error": "message pinning is not supported for newsletters"
}{
"error": "No session"
}{
"error": "Message not found"
}{
"error": "error pinning message: ..."
}Autorizações
Corpo
ID completo retornado pela API ou apenas o messageid
"3A12345678901234567890123456789012"
Define se a mensagem deve ser fixada (true) ou desafixada (false)
true
Duração do pin em dias. Valores aceitos: 1, 7 ou 30. Qualquer outro valor cai para 30.
7
Resposta
Ação de fixar/desafixar mensagem enviada com sucesso
ID único da mensagem gerada para o evento de pin/unpin
"5511999999999:3A12345678901234567890123456789012"
ID da mensagem do evento no WhatsApp
"3A12345678901234567890123456789012"
Chat onde a ação ocorreu
"120363123456789012@g.us"
JID do remetente da ação
"5511999999999@s.whatsapp.net"
Nome do perfil da instância
"Minha Instância"
Indica se o chat é um grupo
true
Indica se a ação foi enviada pela própria instância
true
Payload interno de PinInChatMessage
Tipo da mensagem retornada
"PinInChatMessage"
Origem estimada da mensagem
"web"
Timestamp da mensagem em milissegundos
1704067200000
Status atual da ação
"Pending"
Texto amigável derivado da ação
"Mensagem fixada"
ID da mensagem citada, quando aplicável
""
ID da mensagem editada, quando aplicável
""
Emoji de reação, quando aplicável
""
Opções convertidas para mensagens interativas, quando aplicável
""
Proprietário da instância
"5511999999999"
ID da mensagem alvo que foi fixada ou desafixada
"3EB0538DA65A59F6D8A251"
Estado final solicitado para a mensagem alvo
true