Actions70
- Chat Actions
- Community Actions
- Group Actions
- Instance Actions
- Label Actions
- Message Actions
- Newsletter Actions
- Send Message Actions
- User Actions
Chat → Pin Chat
AI-generatedSummary
Pins a WhatsApp chat to the top of the chat list for a specific instance.
Inputs
- instanceApiKey (required) — Instance API key for authentication.
- chatChat (required) — Chat JID (e.g., 5511999999999@s.whatsapp.net).
- requestOptions — Optional HTTP request settings including batching, SSL verification, proxy, and timeout.
Output shape
no body — success/failure only
Returns HTTP status 200 on success; errors are reported in the response body.
Examples
Example 1: Pin a specific WhatsApp chat to the top of the list.
Set resource to 'Chat', operation to 'Pin Chat', enter the chat JID, and configure the instance API key.