---
title: "Update scene metadata"
method: PATCH
path: "/api/v1/scenes/{sceneId}"
tags: ["scenes"]
---

# Update scene metadata

`PATCH /api/v1/scenes/{sceneId}`

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

## Path parameters

- `sceneId` string, required

## Request body

- object
  - `name` string
  - `pinned` boolean
  - `collectionId` string — Collection ID. Personal API keys may use 'private' for the key owner's virtual private collection. Workspace API keys cannot access private collections.

## Response `200`

This response returns the updated details for the scene.

- object — This response returns the updated details for the scene.
  - `metadata` object, required
    - `workspace` string, required
    - `name` string, required
    - `isUntitled` boolean
    - `created` string, required
    - `updated` string, required
    - `previewUrl` string, required
    - `previewFilename` string, required
    - `previewBackground` string, required
    - `isDeleted` boolean, required
    - `isPrivate` boolean, required
    - `creator` string, required
    - `updater` string, required
    - `sceneVersion` string, required
    - `contentEpoch` integer, required
    - `lastAcknowledgedVersion` integer
    - `linkSharing` union, required
      - 0
      - 1
      - 3
    - `readComments` boolean
    - `writeComments` boolean
    - `allowCalls` boolean
    - `collection` string, required
    - `updateCount` number, required
    - `revisionCount` number, required
    - `lastRevision` string, required
    - `totalElements` number, required
    - `deletedElements` number, required
    - `pinned` boolean, required
    - `hasNonDeletedFrames` boolean
    - `isSlidesSharingEnabled` boolean
    - `isWelcomeScene` boolean
    - `id` string, required
  - `readOnlyLinks` object[], required
    - `id` string, required
    - `scene` string, required
    - `workspace` string, required
    - `created` string, required
    - `updated` string, required
    - `updatedBy` string, required
    - `creator` string, required
    - `preview` string, required
    - `previewPath` string, required
    - `type` 'readonly', required
    - `status` union, required
      - 'active'
      - 'inactive'
    - `name` string, required
    - `data` object, required
      - `showTitle` boolean
      - `showMenu` boolean
      - `darkMode` boolean
      - `disableInteraction` boolean
      - `showDarkModeToggle` boolean
      - `showFrameOutlines` boolean
      - `x` number, required
      - `y` number, required
      - `width` number, required
      - `height` number, required
  - `sharedSlidesLinks` object[], required
    - `id` string, required
    - `scene` string, required
    - `workspace` string, required
    - `created` string, required
    - `updated` string, required
    - `updatedBy` string, required
    - `creator` string, required
    - `preview` string, required
    - `previewPath` string, required
    - `isActive` boolean, required
    - `type` 'slides', required
    - `data` object, required
      - `name` string, required
      - `showSlideTitle` boolean, required
      - `animateSlides` boolean, required
      - `disallowDownload` boolean
      - `autoPlaySlides` number

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

---

[API](https://skmtc.net/excalidraw/apis/excalidraw-api.md) · [All operations](https://skmtc.net/excalidraw/apis/excalidraw-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/excalidraw/excalidraw-api/revisions/c1404d1545ba/schema)