---
title: "PATCH /v1/workflows/{id}/ui-metadata"
method: PATCH
path: "/v1/workflows/{id}/ui-metadata"
---

# PATCH /v1/workflows/{id}/ui-metadata

`PATCH /v1/workflows/{id}/ui-metadata`

Update workflow UI metadata (node positions) in-place

## Path parameters

- `id` string, required

## Request body

- union
  - object
  - UpdateWorkflowUIMetadataParams
    - `expectedCurrentVersion` integer
    - `uiMetadata` WorkflowUIMetadata, required
      - `comments` Comment[]
        - `createdAt` string
        - `createdBy` StickyNoteUser
          - `clientId` string
          - `name` string
        - `id` string
        - `nodeId` string
        - `position` NodePosition
          - `x` number
          - `y` number
        - `replies` CommentReply[]
          - `createdAt` string
          - `createdBy` StickyNoteUser
            - `clientId` string
            - `name` string
          - `id` string
          - `text` string
          - `updatedAt` string
        - `resolved` boolean
        - `text` string
        - `updatedAt` string
      - `nodePositions` object
      - `stickyNotes` StickyNote[]
        - `color` string
        - `createdAt` string
        - `createdBy` StickyNoteUser
          - `clientId` string
          - `name` string
        - `id` string
        - `position` NodePosition
          - `x` number
          - `y` number
        - `size` StickyNoteSize
          - `height` number
          - `width` number
        - `text` string
        - `updatedAt` string
        - `zIndex` integer

## Response `200`

OK

- UpdateWorkflowUIMetadataSuccessResponse
  - `code` integer
  - `data` UpdateWorkflowUIMetadataResponseData
    - `version` integer
  - `message` string
  - `requestId` string

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `409` — Conflict

---

[API](https://skmtc.dev/b3os/apis/b3os-workflow-api.md) · [All operations](https://skmtc.dev/b3os/apis/b3os-workflow-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/b3os/b3os-workflow-api/revisions/a8c7af3c66a1/schema)