Stop a shared link
well_revoke_share_linksStop a shared link made by well_share_widget or well_share_canvas, so it no longer opens for anyone, including from a message already sent. Call it when the person asks to stop, cancel, unshare or revoke a link to a figure or a board.
Pass exactly one of:
url: the link exactly as the person pasted it (it ends in/w/#s=<code>or/b/#s=<code>).share_link_id: the id the share returned, when the link was made earlier in this conversation, or an id well_list_share_links returned.all: true, only when the person asks to stop every shared link of this workspace.
A member stops the links they made; a workspace owner or admin stops any link of the workspace, and all stops every link the caller may stop. A refusal says the link belongs to another member: tell the person that only its author or an owner or admin can stop it.
Never pass all to stop one link. When the person names a link you cannot identify, list the links with well_list_share_links first. This does not stop a document link in an email; that is another tool's link.
The figures and the board stay in Well, and a later share makes a new link; the stopped one never opens again. Tell the person plainly that the link no longer opens. When revoked_count is 0, say this workspace had no such link; never say a link was stopped.
When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| all | No | True to stop every shared link of this workspace. | |
| url | No | The shared link the person pasted. | |
| 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. | |
| share_link_id | No | The id the share or well_list_share_links returned for the link. | |
| 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 | ||
| message | No | ||
| success | Yes | ||
| revoked_ids | No | ||
| revoked_count | 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. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| 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. |