Skip to content

Connect WhatsApp

Unlink the QR session

Logs the linked device out of WhatsApp and clears the session. To use the number again, start a new session and scan a new QR code. Owners and admins signed in to the app only; API keys get 403.

POST/api/whatsapp/disconnect
  • Console only: owner or admin
  • Workspace: X-Tenant-ID

Headers

  • Cookiestringrequired

    The whatsappx_session cookie the app sets when you sign in. Browsers send it automatically; API keys are not accepted on this endpoint.

    Example
    whatsappx_session=…
  • X-Tenant-IDuuidrequired

    Workspace id. Required for session requests. You can pass ?tenant=<id> instead.

    Example
    8d0f6c2e-3b1a-4c55-9a7e-2f4b6d1e9c30

Response

200 OKapplication/json

  • connectedboolean

    The linked session is connected to WhatsApp.

  • logged_inboolean

    The number is linked (paired) to this workspace.

  • qr_pendingboolean

    A QR code is waiting to be scanned.

  • jidstringmay be absent

    WhatsApp id of the linked number, once linked.

Status codes

  • 200OK. The session state after logging out.
  • 401Unauthorized. No signed-in session (unauthorized).
  • 402Payment required. Only when subscriptions are enforced and the workspace has no active subscription. The body includes code: "payment_required".
  • 403Forbidden. API keys can never call this endpoint (API keys cannot administer workspaces). A signed-in user who is not an owner or admin gets admin required; a user who is not a member of the workspace gets forbidden.
  • 500Server error. The session could not be cleared. The error carries the reason.