---
title: "Update"
method: PATCH
path: "/landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId}"
tags: ["Diagrams"]
---

# Update

`PATCH /landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId}`

## Path parameters

- `landscapeId` string, required
- `versionId` string, required
- `diagramId` string, required

## Query parameters

- `updateViewedAt` boolean

## Request body

- DiagramUpsert
  - `commit` number
  - `description` string
  - `groupId` string, nullable
  - `index` number
  - `labels` object
  - `modelId` string — model object id this object belongs to
  - `name` string
  - `parentId` string, nullable
  - `pinned` boolean
  - `pinnedAt` string, date-time
  - `pinnedIndex` number
  - `status` 'current'
  - `zoomOverrides` DiagramZoomOverridesNullable — Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id.
  - `comments` object
    - `$add` object
    - `$remove` string[]
    - `$replace` object
    - `$update` object
  - `connections` object
    - `$add` object
    - `$remove` string[]
    - `$replace` object
    - `$update` object
  - `objects` object
    - `$add` object
    - `$remove` string[]
    - `$replace` object
    - `$update` object

## Response `200`

OK

- object
  - `diagram` Diagram, required
    - `commit` number, required
    - `description` string
    - `groupId` string, nullable, required
    - `index` number, required
    - `labels` object, required
    - `modelId` string, required — model object id this object belongs to
    - `name` string, required
    - `parentId` string, nullable, required
    - `pinned` boolean, required
    - `pinnedAt` string, date-time
    - `pinnedIndex` number
    - `status` 'current', required
    - `zoomOverrides` DiagramZoomOverridesNullable — Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id.
    - `handleId` string, required
    - `type` 'app-diagram' | 'component-diagram' | 'context-diagram', required
    - `commentCount` number, required
    - `connectionCount` number, required
    - `createdAt` string, date-time, required
    - `createdBy` 'user' | 'api-key' | 'notification-key' | 'service', required
    - `createdById` string, required
    - `deletedAt` string, date-time
    - `deletedBy` 'user' | 'api-key' | 'notification-key' | 'service'
    - `deletedById` string
    - `id` string, required
    - `landscapeId` string, required
    - `latestEntityId` string
    - `objectCount` DiagramObjectCount, required
      - `actor` number, required
      - `app` number, required
      - `group` number, required
      - `component` number, required
      - `store` number, required
      - `system` number, required
      - `area` number, required
      - `box` number, required
    - `updatedAt` string, date-time, required
    - `updatedBy` 'user' | 'api-key' | 'notification-key' | 'service', required
    - `updatedById` string, required
    - `version` number, required
    - `versionId` string, required
  - `diagramContent` DiagramContent
    - `comments` object, required
    - `commit` number, required
    - `connections` object, required
    - `objects` object, required
    - `createdAt` string, date-time, required
    - `createdBy` 'user' | 'api-key' | 'notification-key' | 'service', required
    - `createdById` string, required
    - `deletedAt` string, date-time
    - `deletedBy` 'user' | 'api-key' | 'notification-key' | 'service'
    - `deletedById` string
    - `groupId` string, nullable, required
    - `handleId` string, required
    - `id` string, required
    - `landscapeId` string, required
    - `latestEntityId` string
    - `modelId` string, required
    - `name` string, required
    - `status` 'current', required
    - `type` 'app-diagram' | 'component-diagram' | 'context-diagram', required
    - `updatedAt` string, date-time, required
    - `updatedBy` 'user' | 'api-key' | 'notification-key' | 'service', required
    - `updatedById` string, required
    - `version` number, required
    - `versionId` string, required
    - `viewedAt` string, date-time
    - `viewedBy` 'user' | 'api-key' | 'notification-key' | 'service'
    - `viewedById` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `422` — Unprocessable Entity
- `429` — Resource Exhausted
- `500` — Internal Server
- `503` — Service Unavailable

---

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