Get the workspace invitation link
well_get_workspace_invite_linkReturn the link that lets people join the user's OWN workspace, when the user asks for an invitation link into their account or workspace and names no person and no email address. When the user names one person or one address, use well_invite_members with delivery: "link" instead. For a link that lets someone open their own account on Well, use well_get_general_invite_link. When the user does not say which of the two links they mean, ask them before any call.
Pass role: admin or member, the role the link gives, when the user named it; never pick it for them. On WhatsApp, when the user named no role, leave role out: Well's card asks the role, and the role the person picks is their yes. On any other surface, ask the user which role before the call.
workspace_link: every person who opens it joins THIS workspace with role. It works for any number of people and has no expiry. The same role always returns the same link, and the admin link and the member link are two different links.
Only an owner or admin of a company workspace gets a workspace link. Otherwise workspace_link is absent, workspace_link_refusal names why (INSUFFICIENT_PERMISSIONS, DEMO_WORKSPACE for sample data, MEMBERSHIP_WORKSPACE for the person's own space, or LINK_UNAVAILABLE), and general_link carries the general link to Well, to offer in its place. Pass language, the language of the conversation, for the greeting that link carries.
When the user asks to stop the workspace link of a role, use well_delete_workspace_invite_link instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| role | No | The role the workspace link gives: admin or member. Left out on WhatsApp when the user named none, so Well's card asks it; elsewhere ask the user first. | |
| language | No | The language of the conversation, for the greeting of the general link a refusal offers. Defaults to English. | |
| 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 | No | The role the call names. Absent only when the call named none. | |
| error | No | ||
| success | Yes | ||
| general_link | No | Present only when a workspace link is refused and Well has a WhatsApp number: the general link, to offer in its place. It opens the WhatsApp chat with Well, and a person who uses it gets their own workspace, not this one. | |
| workspace_id | No | ||
| workspace_link | No | Present only when the workspace gives a link. Every person who opens it joins the workspace with `role`. It has no expiry and works for any number of people, until the user asks to stop it. Give it to the user exactly as returned. | |
| workspace_name | No | The name of the workspace the link opens. 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_refusal | No | Present only when the call gives no workspace link. INSUFFICIENT_PERMISSIONS: the caller is not an owner or admin of the workspace. DEMO_WORKSPACE: the workspace holds sample data. MEMBERSHIP_WORKSPACE: the workspace is the person's own space, and a workspace link exists only for a company workspace. LINK_UNAVAILABLE: the link cannot be shown again, so stop it with well_delete_workspace_invite_link and ask for a new one. |