---
title: "Share scene by public link"
method: PUT
path: "/api/v1/scenes/{sceneId}/link-sharing"
tags: ["scenes"]
---

# Share scene by public link

`PUT /api/v1/scenes/{sceneId}/link-sharing`

## Request

- Base URL: `https://api.excalidraw.com`
- URL: `https://api.excalidraw.com/api/v1/scenes/{sceneId}/link-sharing`
- Auth: HTTP bearer

Turn the scene's public link on or off and return the link.

    Anyone with the link can open the scene without signing in:
    - `view` lets them view it
    - `edit` lets them edit it
    - `none` turns the link off

    This is the link from the scene's **Share** dialog. When the link is turned on, guests can also read and write comments; turning it off removes their access.

    <Callout type="warn">
    Turning the link on fails with 403 when a workspace admin has disabled scene sharing for the workspace.
    </Callout>

    **Use cases:**
    - Sharing a diagram with people outside the workspace
    - Letting guests edit a scene
    - Revoking public access to a scene

## Path parameters

- `sceneId` string, required

## Request body

- object
  - `access` 'none' | 'view' | 'edit', required: What anyone with the link may do: 'view', 'edit', or 'none' to turn the link off.

## Response `200`

This response returns the scene's link access and public link.

- object: This response returns the scene's link access and public link.
  - `access` 'none' | 'view' | 'edit', required
  - `url` unknown, required

## Other responses

- `400`: This response indicates that the request was malformed or contained invalid parameters.
- `401`: This response indicates that the client must authenticate to access the requested resource.
- `403`: This response indicates that the client does not have permission to access the requested resource.
- `404`: This response indicates that the requested resource could not be found.

## Changes

- **2026-10-29** `9eecb866ae18`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/excalidraw/apis/excalidraw-api/changes/api/v1/scenes/:sceneId/link-sharing/put.md)

---

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