scenes

Update scene metadata

Changed on

Update specific metadata fields of an existing scene.

You can update:
- Scene name
- Pinned status
- Collection assignment
- Any combination of the above fields

<Callout type="info">
This endpoint uses partial updates - only provide the fields you want to change. Omitted fields will remain unchanged.
</Callout>

<Callout type="warn">
Moving a scene to a different collection may affect sharing permissions and access rights depending on collection settings.
</Callout>

**Use cases:**
- Renaming scenes
- Organizing scenes by pinning/unpinning
- Moving scenes between collections
- Bulk metadata updates
patch/api/v1/scenes/{sceneId}

Request

  • Base URL
    https://api.excalidraw.com
  • URL
    https://api.excalidraw.com/api/v1/scenes/{sceneId}
  • Auth
    HTTP bearer

Path parameters

sceneIdstring required

Request body

namestring
pinnedboolean
collectionIdstring

Collection ID. Personal API keys may use 'private' for the key owner's virtual private collection. Workspace API keys cannot access private collections.

Response

This response returns the updated details for the scene.

Changes

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • warning

      removed the optional property / from the response with the status