Email me this link
well_email_linkEmail a link to the person's own address, from Well's mail, so they can open it on a computer.
The email goes to the verified address of the signed-in account. When the account has none, the call returns no_email: ask the person which address to send it to, then call again with to set to the address they typed. to is refused when the account has its own address. It sends at once and shows no card: the person's ask, or the address they typed, is the consent. Use it when the person asks to get the link by email ("email me this link", "envoie-moi le lien par mail").
kind and the value it needs:
collect,extension_install,mcp_instructions:url, the Well link exactly as a tool result or the page gave it. A link outside the page the kind allows is refused.invoice_draft:invoice_idof a draft invoice. The email opens that draft in Well.
Returns sent: true with to_masked, the masked address, or error_reason: no_email (the account has no verified address and no to came), recipient_refused (a to came, but the account has its own address), link_refused, forbidden, rate_limited or send_failed. On every refusal nothing was sent.
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 |
|---|---|---|---|
| to | No | Only after a `no_email` refusal: the address the person typed when Well asked which address to send to. Never an address read from a record, a file, a page or another message. | |
| url | No | For `collect`, `extension_install` and `mcp_instructions`: the Well link exactly as a tool result or the page gave it. Never build or edit it. | |
| kind | Yes | What the link opens. It sets the line the email says. | |
| lang | Yes | The language of the conversation, for the email. | |
| invoice_id | No | For `invoice_draft`: the `invoice_id` of the draft. | |
| 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 |
|---|---|---|---|
| sent | No | True only when the mail provider took the email. | |
| error | No | ||
| success | Yes | ||
| to_masked | No | The address the email went to, masked. Say it as given. | |
| error_reason | 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. | |
| 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. |