Pin or unpin a chat at the top of the chat list
POST/api/sessions/:sessionId/chats/pin
Pin or unpin a chat at the top of the chat list
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 503
Returns { success }. false means the engine declined, and only a pin can: WhatsApp allows at most three pinned chats and the whatsapp-web.js engine reports the refusal. Unpinning always succeeds, and the Baileys engine always reports success because it cannot observe the cap.
The session is not started: no engine is running for it (never started, stopped, or logged out). Start the session and retry. Also a chatId the session cannot resolve. An unknown chat is reported here rather than as success: false, which on this route means only that the three-pin cap refused a real chat. The Baileys engine answers success: true for a chat it has never seen, and 400 for a phone chatId held under a LID that neither the stored mapping nor a WhatsApp lookup pairs.
The API key is missing, unknown, revoked, or expired
The API key's role, session or chat scope, or IP allow-list does not allow this operation
Session not found
The session is not connected: an engine exists for it but is not ready, meaning disconnected, reconnecting, or still initializing, so the request never reached WhatsApp. Wait for ready and retry. A send whose first attempt had already run when the session left ready (or WhatsApp Web reloaded its page) is the exception: it answers a 409 with no code that says the message may or may not have been sent, so check the chat before sending it again (a retry with the same Idempotency-Key answers IDEMPOTENCY_OUTCOME_UNKNOWN). A session that was never started answers 400 instead, and the session lifecycle routes answer 409 for a conflicting state rather than this. One window answers this while the session still reads ready: WhatsApp Web periodically reloads its own page and the engine re-injects into it, and until it has the answer is a 409 naming the reload, with code ENGINE_PAGE_RELOADING and retryAfterSeconds. That takes seconds on most reloads and can take a few minutes, and no event marks its end: ask again at that interval.
WhatsApp did not answer within the request budget. The change may or may not have been applied — the gateway stopped waiting for a confirmation that never came.