---
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` GithubComB3FunB3MonoServicesB3osWorkflowInternalPkgEntityWorkflowUIMetadata, required
      - `comments` GithubComB3FunB3MonoServicesB3osWorkflowInternalPkgEntityComment[]
        - `createdAt` string
        - `createdBy` GithubComB3FunB3MonoServicesB3osWorkflowInternalPkgEntityStickyNoteUser
          - `clientId` string
          - `name` string
        - `id` string
        - `nodeId` string
        - `position` GithubComB3FunB3MonoServicesB3osWorkflowInternalPkgEntityNodePosition
          - `x` number
          - `y` number
        - `replies` GithubComB3FunB3MonoServicesB3osWorkflowInternalPkgEntityCommentReply[]
          - `createdAt` string
          - `createdBy` GithubComB3FunB3MonoServicesB3osWorkflowInternalPkgEntityStickyNoteUser
            - `clientId` string
            - `name` string
          - `id` string
          - `text` string
          - `updatedAt` string
        - `resolved` boolean
        - `text` string
        - `updatedAt` string
      - `nodePositions` object
      - `stickyNotes` GithubComB3FunB3MonoServicesB3osWorkflowInternalPkgEntityStickyNote[]
        - `color` string
        - `createdAt` string
        - `createdBy` GithubComB3FunB3MonoServicesB3osWorkflowInternalPkgEntityStickyNoteUser
          - `clientId` string
          - `name` string
        - `id` string
        - `position` GithubComB3FunB3MonoServicesB3osWorkflowInternalPkgEntityNodePosition
          - `x` number
          - `y` number
        - `size` GithubComB3FunB3MonoServicesB3osWorkflowInternalPkgEntityStickyNoteSize
          - `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.net/b3-fun/apis/b3os-workflow-api.md) · [All operations](https://skmtc.net/b3-fun/apis/b3os-workflow-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/b3-fun/b3os-workflow-api/versions/5a750a5a9596/schema)