Skip to main content
Chat endpoints operate on a chat JID or phone number.

Chat state

EndpointBodyUse
POST /chat/pinChat, PinPin or unpin state through the pin handler.
POST /chat/unpinChatUnpin a chat.
POST /chat/archiveChat, ArchiveArchive or unarchive a chat.
POST /chat/muteChat, Mute, DurationMute a chat.
POST /chat/deletePhoneDelete a chat or group from the connected account.
POST /chat/readPhoneMark a chat read.
POST /chat/unreadPhoneMark a chat unread.
Use a group JID for groups and a phone/JID for one-to-one chats.

Presence indicators

EndpointBodyUse
POST /chat/typing/startJidShow typing in a chat.
POST /chat/typing/stopJidStop typing presence.
POST /chat/recording/startJidShow audio recording presence.
POST /chat/recording/stopJidStop recording presence.
Presence is temporary. Your app should stop typing or recording when the user leaves the composer.

Disappearing messages

curl -X POST http://localhost:1337/chat/disappearing-timer \
  -H "Content-Type: application/json" \
  -H "token: YOUR_TOKEN" \
  -d '{
    "phone": "15551234567",
    "timer": "24h"
  }'
Valid timer values in the docs/spec are off, 24h, 7d, and 90d. The handler parses the string into WhatsApp disappearing timer behavior.