Subscribe to a channel using invite code

POST 
/api/sessions/:sessionId/channels/subscribe

Subscribe to a channel using invite code

Request

Responses

201

Successfully subscribed to channel

404

The invite code does not resolve to a channel — it is wrong, expired, or revoked. This route takes an invite code rather than a channel id.

409

The session is not connected — an engine exists for it but is not ready: disconnected, reconnecting, or still initializing, so the request never reached WhatsApp. Wait for ready and retry. 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 — for those few seconds the answer is a 409 naming the reload; retry shortly.

501

Not supported by the active engine: whatsapp-web.js cannot subscribe by invite code.

503

WhatsApp did not answer within the request budget — the operation may or may not have applied.