scenes

Share scene by public link

Changed on

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
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

Path parameters

sceneIdstring required

Request body

access'none' | 'view' | 'edit' required

What anyone with the link may do: 'view', 'edit', or 'none' to turn the link off.

Response

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

access'none' | 'view' | 'edit' required
urlunknown required

Changes