API Reference

Pin Chat

Pins a chat to the top of the chat list. The operation may fail if the maximum number of pinned chats (3) has been reached.

Log in to see full request history
Path Params
int64
required

The ID of the WhatsApp instance

Body Params

Chat details for pinning

string
required

Chat ID <countrycode_short>@c.us or @g.us for groups

Response

Response body
object
string of strings

success error

string

ID of the WhatsApp instance

data
object
boolean

Indicates if the chat was successfully pinned

string

Status message of the operation

Language
Credentials