well_revoke_document_shares - Well

Stop a document download link, so it no longer opens for anyone, including in an email already sent. Call it when the user asks to stop sharing, unshare or revoke a link.

well_draft_email puts such a link in the body of every email draft it shows (a URL ending in /document-shares/<code>). Pass exactly one of:

url: the link exactly as the user pasted it.
invoice_id: when the user names an invoice instead, by its id or its number (INV-2026-0148); every live link of that invoice stops. A number several invoices carry is refused with each one named: ask which.
document_id: when the user names another PDF that was linked.

Only an owner, an admin or a member who holds the invoice right can stop a link. When the call is refused for that, tell the user who can stop it and do not retry.

The document itself stays in Well. A later well_draft_email for the same document makes a new link, and the stopped one never opens again. Tell the user plainly that the link no longer opens. When revoked_count is 0, say this workspace had no live link to stop; 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.

Name	Required	Description
`url`	No	The document link the user pasted.
`invoice_id`	No	The UUID of the invoice to stop sharing. When the person named it by its reference instead (DRAFT-061, the number a draft shows, or an issued number), pass that reference: Well resolves it, and refuses a reference that names several invoices.
`document_id`	No	The PDF whose link stops.
`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.

Name

Required

Description

Default

url

The document link the user pasted.

invoice_id

The UUID of the invoice to stop sharing. When the person named it by its reference instead (DRAFT-061, the number a draft shows, or an issued number), pass that reference: Well resolves it, and refuses a reference that names several invoices.

document_id

The PDF whose link stops.

workspace_id

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

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

Optional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation.

workspace_scope

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.

Name	Required	Description
`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.

Name

Required

Description

Default

error

message

success

Yes

revoked_ids

revoked_count

conversation_id

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

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

The workspace that answered, when the caller named none and the token authorizes several.

conversation_id_note

Present only when the server opened a fresh lane, stating that no choice recorded earlier was read.

conversation_id_source

Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened.

Previous value: -"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. Start the reply with 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."New value: +"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."

Added value: +{ + "description": "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.", + "enum": [ + "family" + ], + "type": "string" +}

Added value: +{ + "description": "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. Start the reply with 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.", + "items": { + "additionalProperties": false, + "properties": { + "name": { + "type": "string" + }, + "service_id": { + "type": "string" + } + }, + "required": [ + "name", + "service_id" + ], + "type": "object" + }, + "type": "array" +}

Well

Stop sharing a document link

Input Schema

Output Schema

Schema Changelog

TDQS

Glama MCP Gateway

Resources