Skip to main content
Pin or unpin a chat conversation to the top of the chat list. Pinned chats remain at the top for easy access.
WhatsApp allows a maximum of 3 pinned chats at a time. Attempting to pin more than 3 chats will fail.

​
Request

​
chat_jid
string
required
Chat JID identifier:Example: [email protected]
​
X-Device-Id
string
Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default.
​
pinned
boolean
required
Whether to pin (true) or unpin (false) the chat

​
Response

​
code
string
Response code (e.g., SUCCESS)
​
message
string
Response message describing the resultExample: Chat pinned successfully
​
results
object
​
status
string
Status of the operationExample: success
​
message
string
Detailed status message
​
chat_jid
string
The JID of the affected chat
​
pinned
boolean
The new pinned status
curl -X POST \
  'https://your-api-domain.com/chat/[email protected]/pin' \
  -H 'Content-Type: application/json' \
  -H 'X-Device-Id: my-device' \
  -u 'username:password' \
  -d '{
    "pinned": true
  }'

{
  "code": "SUCCESS",
  "message": "Chat pinned successfully",
  "results": {
    "status": "success",
    "message": "Chat pinned successfully",
    "chat_jid": "[email protected]",
    "pinned": true
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us