Skip to main content
Chat actions update the linked device’s own chat list and settings. They do not remove content from other participants’ devices. Before using chat actions, the token must be paired and connected: 
{
  "paired": true,
  "connected": true
}

​
Apply a chat action

POST /api/v1/sessions/{sessionId}/chats/action
Authorization: Bearer <api_key>
Content-Type: application/json

{
  "chatJid": "[email protected]",
  "action": "mute",
  "muteEndTimestampMs": 4102444800000
}
Supported actions:
ActionEffect
mute / unmuteTurn notifications off or on.
pin / unpinPin or unpin the chat in your chat list.
archive / unarchiveMove the chat into or out of archived chats.
mark_read / mark_unreadUpdate read state.
lock / unlockUpdate chat lock state.
clearClear messages from your linked device.
deleteDelete the chat from your linked device.
For clear, you can include deleteStarred and deleteMedia. For delete, you can include deleteMedia. Successful responses are wrapped in data: 
{
  "data": {
    "sessionId": "01J...",
    "to": "[email protected]",
    "action": "mute",
    "messageId": null
  }
}

​
Star a message

POST /api/v1/sessions/{sessionId}/chats/messages/star
Authorization: Bearer <api_key>
Content-Type: application/json

{
  "message": {
    "chatJid": "[email protected]",
    "id": "3EB0A1B2C3D4E5F6",
    "fromMe": false
  },
  "starred": true
}
Set starred to false to remove the star.