Delete the workspace invitation link
well_delete_workspace_invite_linkDestructiveIdempotent
Stop the workspace link of one role, when the user asks to stop, cancel or delete the invitation link into their own workspace. From then on the link admits nobody. The people who already joined through it stay in the workspace.
Pass role: admin or member, the role of the link to stop. Ask the user which role when they named none.
workspace_link_deleted is true when a link was stopped and false when no link was live for that role. A later well_get_workspace_invite_link for that role makes a new link, and the stopped one never works again. Only an owner or admin of the workspace may stop a link; otherwise workspace_link_refusal is INSUFFICIENT_PERMISSIONS and nothing changes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| role | Yes | The role of the workspace link to stop: admin or member. | |
| 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 |
|---|---|---|---|
| role | Yes | The role the call names. | |
| error | No | ||
| success | Yes | ||
| workspace_id | No | ||
| workspace_name | No | The name of the workspace the link opened. Absent when the caller is not an owner or admin of it. | |
| 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. | |
| workspace_link_deleted | No | Present when the caller may stop the link. True when a live link was stopped: it admits nobody from now on, and the people who already joined stay. False when no link was live for this role. | |
| workspace_link_refusal | No | Present when the caller is not an owner or admin of the workspace, so no link was stopped. |