Share accounts and strategies with people or a link
private_share_linkUse list_access to read people (email, name, invited/active), restricted/anyone link access, the stable copyable link, what viewers see and Marketplace state. invite and remove_viewer manage view-only people; set_access changes restricted/anyone access; reset explicitly invalidates the old link; preview opens the normal account or strategy page with viewer data only. Reading/copying never rotates a link. There are no sharing passwords or payment requirements. Existing create/revoke remain compatible.
Set "action" to choose the operation. Only send the fields listed for that action.
action="create": Create or rotate a private account or strategy link
Required fields: publicationId. Issues a high-entropy bearer link for one explicit publication. Reopening returns the same link; only an explicit rotation changes it. Anyone with the link can forward it; use private_share_link(action="revoke") to invalidate it. Links use the secret URL and stored access permissions, never an extra password. New links have no extra password. Expiry, revocation and named-recipient permissions still apply.
action="revoke": Revoke a private account or strategy link
Required fields: publicationId. Immediately invalidates the bearer link for exactly one owner publication.
action="list_access": List people and link access
Required fields: publicationId. Owner-only sharing, using the same service as the website. People are viewers, never traders. Restricted access requires an invited sign-in; anyone access permits forwarding the secret link. Account viewers use a free sign-in, never checkout. Copying or reading access never changes a link. Only reset changes it and immediately invalidates the old link. No sharing password exists. An invite saves access without sending an email. Active means the email has a registered account; invited means it can register later. Responses include the people list, link access and stable URL, permitted performance/positions/filled trades, Marketplace listing state and the canonical viewer preview URL.
action="invite": Invite people to view
Required fields: publicationId, emails.
action="remove_viewer": Remove a viewer
Required fields: publicationId, email.
action="set_access": Set restricted or anyone link access
Required fields: publicationId, linkAccess.
action="reset": Reset the sharing link
Required fields: publicationId.
action="preview": Preview the normal page as a viewer
Required fields: publicationId.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"action": "<action>"
},
"name": "private_share_link"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Used with action="remove_viewer". Required for action="remove_viewer". | ||
| action | Yes | Which operation to run: "create", "revoke", "list_access", "invite", "remove_viewer", "set_access", "reset", "preview". See the tool description for each one. | |
| emails | No | Used with action="invite". Required for action="invite". | |
| rotate | No | Invalidate the prior token and issue a new one. Used with action="create". | |
| expiresAt | No | Optional ISO-8601 expiration. Must be in the future. Used with action="create". | |
| linkAccess | No | Used with action="set_access". Required for action="set_access". | |
| publicationId | No | Used with action="create", action="revoke", action="list_access", action="invite", action="remove_viewer", action="set_access", action="reset", action="preview". Required for action="create", action="revoke", action="list_access", action="invite", action="remove_viewer", action="set_access", action="reset", action="preview". | |
| recipientEmail | No | Restrict access to one authenticated existing BotSpot user. Used with action="create". |