Share scene by public link
Turn the scene's public link on or off and return the link.
Anyone with the link can open the scene without signing in:
viewlets them view iteditlets them edit itnoneturns 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.
Turning the link on fails with 403 when a workspace admin has disabled scene sharing for the workspace.
Use cases:
- Sharing a diagram with people outside the workspace
- Letting guests edit a scene
- Revoking public access to a scene
PUT
apiKeyheader
AuthorizationBearer <Bearer>The API will use the Authorization: Bearer <your-key> header for requests.
sceneId*stringapplication/json- body
access*stringWhat anyone with the link may do: 'view', 'edit', or 'none' to turn the link off.
Value in
"none""view""edit"This response returns the scene's link access and public link.
application/json- response
This response returns the scene's link access and public link.
access*stringValue in
"none""view""edit"url*|The public link to the scene, or null when the link is off.
curl -X PUT 'https://api.excalidraw.com/api/v1/scenes/string/link-sharing' \
-H 'Content-Type: application/json' \
-d '{
"access": "none"
}'Example Response
{
"access": "none",
"url": "string"
}Last updated on
