Act on a chat | Swarmhit Developers

action: setReadStatus, setMuteStatus, setArchiveStatus, setPinnedStatus (value true/false), addParticipant, removeParticipant (value a JID; groups only), setLabel (value a label id), getInviteLink (groups; answers invite_link). 400 for an unknown action or a missing value.

Authorization

X-API-KEY<token>

Your API key from the console (gw_live_…).

In: header

Path Parameters

id*string

A chat id (wac_…), or a WhatsApp JID / phone number together with account_id.

Query Parameters

account_id?string

The account the id belongs to: required when the path names a JID or a phone number instead of Swarmhit's id.

Lengthlength <= 4096

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

action*string

What to do. setReadStatus (true marks the chat read, false unread), setMuteStatus (true mutes it with no end, false unmutes), setArchiveStatus, setPinnedStatus, addParticipant / removeParticipant (groups only), setLabel, getInviteLink (groups only).

Value in

"setReadStatus"
"setMuteStatus"
"setArchiveStatus"
"setPinnedStatus"
"addParticipant"
"removeParticipant"
"setLabel"
"getInviteLink"

value?|

Required for every action but getInviteLink. The four set…Status actions: true or false ("true", 1 and "1" also mean true). addParticipant / removeParticipant: the person's JID or phone number. setLabel: the label id (up to 100 characters).

Response Body

`application/json`

curl -X PATCH "https://example.com/whatsapp/api/v1/chats/wac_k3J9sLq2Vx8nB4mR?account_id=wa_Xk2pQ9rT4vW8yZ1a" \  -H "Content-Type: application/json" \  -d '{    "action": "setReadStatus",    "value": true  }'

{  "object": "ChatPatched"}

Authorization

Path Parameters

Query Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

502application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`