---
title: "Create a share link (edit or view role, optional expiry)."
method: POST
path: "/documents/{id}/share"
tags: ["Sharing"]
---

# Create a share link (edit or view role, optional expiry).

`POST /documents/{id}/share`

## Request

- Base URL: `https://www.livediagram.app/api`
- URL: `https://www.livediagram.app/api/documents/{id}/share`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Owner-Id`

## Path parameters

- `id` string, required

## Request body

- object
  - `role` 'view' | 'participate' | 'edit', required
  - `expiry` 'never' | 'week' | 'month' | 'sixMonths'
  - `tabId` string, nullable

## Response `201`

Success.

- object
  - `link` ShareLink, required
    - `code` string, required
    - `createdAt` number, required
    - `documentId` string, required
    - `expiresAt` number, nullable, required
    - `expiry` 'never' | 'week' | 'month' | 'sixMonths', required
    - `purpose` 'share' | 'community', required
    - `role` 'view' | 'participate' | 'edit', required
    - `tabId` string, nullable, required

## Other responses

- `400`: Error.
- `401`: Error.
- `403`: Error.
- `404`: Error.
- `410`: Error.
- `429`: Rate limited. Back off and retry.

---

[API](https://skmtc.dev/livediagram/apis/livediagram-api.md) · [All operations](https://skmtc.dev/livediagram/apis/livediagram-api/llms.txt) · [OpenAPI document](https://skmtc.dev/livediagram/apis/livediagram-api/revisions/f7eca2dc5e58?raw)