Pular para o conteúdo principal
POST
/
api
/
chat
/
markChatRead
/
:instance
Marcar chat como lido
curl --request POST \
  --url https://api.example.com/api/chat/markChatRead/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "read": true
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

​
Descrição

Marca todas as mensagens não-lidas de um chat como lidas (read: true) ou desfaz a marcação (read: false). É equivalente a abrir o chat no celular: o badge de mensagens novas zera.
Para marcar uma única mensagem (sem zerar o badge), use markRead.

​
Exemplos

​
Marcar como lido

Com read: true, marca todas as mensagens não-lidas do chat como lidas e zera o badge, equivalente a abrir a conversa no celular. 
curl -X POST "https://ryzeapi.cloud/api/chat/markChatRead/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "read":   true
  }'

​
Marcar como não-lido

Com read: false, restaura o estado de “não-lido” no chat para que ele volte a aparecer destacado na lista, útil para revisitar uma conversa mais tarde. 
curl -X POST "https://ryzeapi.cloud/api/chat/markChatRead/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "read":   false
  }'

​
Resposta de sucesso

A resposta confirma a operação com chat_jid (JID resolvido a partir do number) e read refletindo o estado final. A message muda conforme o valor de read: "Chat marked as read successfully" ou "Chat marked as unread successfully".
200 OK
{
  "success": true,
  "message": "Chat marked as read successfully",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "read": true
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

NomeObrigatórioExemploDescrição
Content-Typesimapplication/json—
tokensim (ou Authorization)a1b2c3d4-...TokenAccount ou TokenInstance.

​
Request body

​
number
string
obrigatório
Telefone, JID privado (...@s.whatsapp.net ou ...@lid), JID de grupo (...@g.us) ou newsletter.
​
read
boolean
obrigatório
true marca como lido, false marca como não-lido.

​
Respostas de erro

HTTPerror.messageQuando ocorre
400Instance name is required—
400Invalid request body: <...>JSON malformado.
400Number is required—
401Invalid token—
404Instance not found—
503Instance is not connected to WhatsApp—
Erro 400
{
  "success": false,
  "error": { "message": "Number is required" }
}

​
Relacionados

Marcar mensagem como lida

Marcar uma única mensagem.

Arquivar chat

Após zerar o badge, arquivar.