Delete an invoice's customer page
well_delete_invoice_portal_linkDelete the customer page of one issued invoice: the page whose address and QR code the invoice prints, and that well_mint_payment_link gives as portal_url. After the delete, that address no longer opens for anyone, including from a PDF or a message already sent, and its card payment link is turned off at the provider. Call it only when the owner asks to delete, stop or cancel an invoice's customer page or payment link; never on your own. The invoice itself stays.
Pass invoice_id: the invoice's id, or the number the owner named it by (INV-2026-0148).
The result's outcome:
deleted: tell the owner the page and its address no longer open. A later well_mint_payment_link makes a new page with a new address; the deleted one never opens again.no_live_link: the invoice has no customer page; say so, and never say one was deleted.provider_link_kept: nothing was deleted, andmessagesays why. Giveconnect_urlas a plain link when it is present. Never retry on your own.
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 |
|---|---|---|---|
| invoice_id | Yes | The UUID of the invoice to delete the customer page of. 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. | |
| 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 | ||
| mint | No | ||
| error | No | ||
| message | No | ||
| outcome | No | ||
| success | Yes | ||
| invoice_id | No | ||
| connect_url | 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. |