Delete document
well_delete_documentDelete a document (a file: an invoice PDF, a receipt, a statement, a payslip) from the current workspace (soft delete).
Use this tool when the user asks to delete or remove a file ("Delete the Uber receipt I sent this morning"). Find the document_id first with well_query_records or well_get_entity. When more than one document could be the one meant, ask which one and delete nothing.
REQUIRED: document_id.
A document that a connected tool synced in (a drive, an accounting tool) is not deleted: the next sync would bring it back. The copy of an issued invoice is not deleted either: it is kept as issued. The call then fails and nothing is deleted. The person confirms the delete on a card before anything is removed.
The transactions a statement created and the payslips read from the file stay in Well after the delete. derived_records counts them: total, removable, and kept per reason (closed period, no date, connected tool, ledger entry, invoice match, expense note or shared-expense repayment, receipt or payslip match); null when Well could not count them. When next_step is present, tell the person how many transactions and payslips the file created and ask whether to delete them too, unless their request already asked for that. Call next_step.tool with next_step.input only once they said yes, in that request or after the question. Without next_step, say the rows stay and why.
Returns { success: true, document_id, filename, derived_records, next_step? } on success, or { success: false, error } on failure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| document_id | Yes | The document to delete. | |
| 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 |
|---|---|---|---|
| code | No | ||
| error | No | ||
| success | Yes | ||
| filename | No | ||
| next_step | No | ||
| document_id | No | ||
| reply_lines | 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. | |
| derived_records | No | ||
| near_candidates | No | ||
| 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. | |
| near_candidates_truncated | No |