<!--
  immut documentation, machine-readable.

  Everything in one file:  https://www.immut.io/llms-full.txt
    What immut is, which integration path to choose, authentication and scopes, and the COMPLETE
    API reference: every endpoint with parameters, responses and a runnable curl. Fetch this first
    if you intend to call the API.

  Index of all pages:      https://www.immut.io/llms.txt
  OpenAPI contract:        https://www.immut.io/docs/openapi.json
  This page as HTML:       https://www.immut.io/docs/mcp/create_share_link

  Any page on this site is available as raw markdown by appending .md to its URL.
-->


# create_share_link

**Share files with a named person**

Create a link that named people can open, for a document, a folder or a whole workspace. Use it to hand a report and its files to an investor or adviser. ⛔ THIS SENDS SOMEONE ELSE'S DOCUMENTS TO AN OUTSIDER: ask your human first, every time, and read the recipient list back to them before you call it. Recipients and an expiry are both required. Each recipient confirms a code sent to their email before the link opens, and every open is logged against that email address.

- Access: write
- Calls: `/api/v1/share-links`

## Arguments

| Name | Type | Required | Description |
|---|---|---|---|
| `resourceType` | `document` \| `folder` \| `workspace` | **yes** | What to share |
| `resourceId` | string | **yes** | Id of the document, folder or workspace |
| `recipientEmails` | string | **yes** | Who may open it. At least one; each is verified by email code |
| `expiresInDays` | number | **yes** | Required. How many days the link lives |
| `accessLevel` | `view` \| `download` | no | view (default) or download |

## Tool contract

```json
{
  "name": "create_share_link",
  "title": "Share files with a named person",
  "description": "Create a link that named people can open, for a document, a folder or a whole workspace. Use it to hand a report and its files to an investor or adviser. ⛔ THIS SENDS SOMEONE ELSE'S DOCUMENTS TO AN OUTSIDER: ask your human first, every time, and read the recipient list back to them before you call it. Recipients and an expiry are both required. Each recipient confirms a code sent to their email before the link opens, and every open is logged against that email address.",
  "access": "write",
  "destructive": false,
  "hostedOnProduction": true,
  "restEndpoint": "/api/v1/share-links",
  "arguments": {
    "resourceType": {
      "type": "enum",
      "required": true,
      "description": "What to share",
      "values": [
        "document",
        "folder",
        "workspace"
      ]
    },
    "resourceId": {
      "type": "string",
      "required": true,
      "description": "Id of the document, folder or workspace"
    },
    "recipientEmails": {
      "type": "string",
      "required": true,
      "description": "Who may open it. At least one; each is verified by email code"
    },
    "expiresInDays": {
      "type": "number",
      "required": true,
      "description": "Required. How many days the link lives"
    },
    "accessLevel": {
      "type": "enum",
      "required": false,
      "description": "view (default) or download",
      "values": [
        "view",
        "download"
      ]
    }
  }
}
```