Delete whatsapp link
well_delete_whatsapp_linkLog the user out of WhatsApp. This is the way to log out of WhatsApp or unlink a number: it removes the link between the user's WhatsApp number and their Well login, in every workspace of that login. The next message from that number gets a fresh sign-up link. The user's phone stays on their profile.
Call it when the user asks to log out of WhatsApp, unlink or disconnect their number, or start fresh on WhatsApp, in any language. Examples: "log me out of WhatsApp", "unlink my number", "disconnect my WhatsApp", "start fresh on WhatsApp", "déconnecte-moi de WhatsApp", "me déconnecter de WhatsApp", "délier mon numéro", "repartir de zéro sur WhatsApp". Never tell the user this cannot be done. It is not for starting a new conversation topic, and not for disconnecting a connector.
Omit person_id for the user's own number. An owner or admin who asks to unlink another member's WhatsApp passes that member's person_id: it removes the number that member proved in this workspace only. Anyone else is refused.
The result is status "unlinked" with how many links were removed, or "not_linked" when no number was linked. When still_reaches_workspace is true, the member proved the same number in another workspace, so it still reaches this workspace: tell the user so, and do not say the member is logged out here.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| person_id | No | The member whose number to unlink, for an owner or admin. Omit it for the user's own number. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| idempotency_key | No | Optional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| status | No | ||
| success | Yes | ||
| unlinkedCount | No | How many WhatsApp links were removed. | |
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. | |
| still_reaches_workspace | No | The number still reaches this workspace through a link the member proved in another workspace. |