Delete the referral link
well_delete_referral_codeDestructiveIdempotent
Stop the workspace's referral link, when the user asks to stop, cancel, delete or replace their referral link. From then on a signup with the old link counts for nobody. The people who already joined with it keep their own accounts.
referral_link_deleted is true when the live link was stopped and false when the workspace had none. To give a new link, call well_create_referral_code after this: it makes a new code, and the old one never counts again. Only an owner or admin of the workspace, or the member who made the link, may stop it; otherwise refusal is INSUFFICIENT_PERMISSIONS and nothing changes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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 | ||
| refusal | No | Present only when nothing was stopped. DEMO_WORKSPACE: a demo workspace has no referral link. INSUFFICIENT_PERMISSIONS: only an owner or admin of the workspace, or the member who made the link, may stop it. | |
| success | Yes | ||
| workspace_id | No | ||
| 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. | |
| referral_link_deleted | No | True when the live referral link was stopped: a signup with it counts for nobody from now on, and the people it already brought in keep their own accounts. False when the workspace had no live referral link. | |
| 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. |