v9

latestOpenAPI 3.0.3raw.githubusercontent.com2026-07-2181734.3 KB
whatsappAccounts

Disconnect WhatsApp account

Forcibly disconnects the WhatsApp account currently linked to a specific user. If the user has an active WhatsApp connection, the session is terminated, sync is stopped and credentials are revoked. The response includes identifiers of the disconnected WhatsApp account and phone number together with a disconnected=true flag and the disconnection timestamp. If the user has no active WhatsApp account, the operation is treated as an idempotent no-op and returns disconnected=false. The call is still subject to standard partner authentication and workspace ownership checks.

post/workspaces/{workspace_id}/users/{user_id}/whatsapp/disconnect

Path parameters

workspace_idstring required

The unique identifier for the workspace.

user_idinteger required

The unique identifier for the user.

Headers

X-TL-Partner-Idstring required

The unique identifier for the partner.

Response

WhatsApp disconnected

workspace_idstring

Unique identifier for the workspace

user_idinteger

Unique identifier for the user

disconnectedboolean

Indicates whether a WhatsApp account was disconnected

disconnected_atstring date-time

Timestamp of the disconnection event

whatsapp_account_idinteger

ID of the disconnected WhatsApp account

phone_numberstring

Phone number associated with the disconnected WhatsApp account

descriptionstring

Additional information about the disconnection

Example response

{
  "disconnected_at": "2024-01-01T12:00:00Z"
}