---
title: "Update version metadata (label, description, pin only)"
method: PATCH
path: "/agent/{id}/versions/{versionId}"
tags: ["Agent Versioning - Versions"]
---

# Update version metadata (label, description, pin only)

`PATCH /agent/{id}/versions/{versionId}`

Update a published version's label, description, or pinned status. At least one field is required.
Published versions (both active and inactive) are config-immutable — their agent
configuration cannot be changed. To modify config, create a new draft from the version,
edit the draft, and publish it as a new version.

## Path parameters

- `id` string, required
- `versionId` string, required

## Request body

- UpdateVersionMetaRequest — At least one of label, description, or isPinned must be provided.
  - `label` string, nullable — Version label
  - `description` string, nullable — Version description
  - `isPinned` boolean — Pin or unpin the version

## Response `200`

Version metadata updated

- object
  - `status` boolean
  - `data` AgentVersion — Represents either a draft revision or a published version of an agent's configuration.
    - `_id` string — Unique identifier
    - `agent` string — The agent this version belongs to
    - `status` 'published' | 'draft' | 'archived' — Current status of the version record
    - `versionNumber` integer, nullable — Auto-incremented version number (published versions only)
    - `label` string, nullable — Human-readable label for the version
    - `description` string, nullable — Description of what changed in this version
    - `isPinned` boolean — Whether the version is pinned for quick access
    - `publishedBy` string, nullable — User ID of who published this version
    - `publishedAt` string, date-time, nullable — When this version was published
    - `activatedBy` string, nullable — User ID of who activated this version
    - `activatedAt` string, date-time, nullable — When this version was activated
    - `draftId` string, nullable — Unique draft identifier (drafts only)
    - `draftName` string, nullable — Human-readable draft name
    - `draftRevision` integer, nullable — Revision number within the draft (drafts only)
    - `sourceVersionId` string, nullable — The published version this draft was branched from
    - `blocks` object — References to the 13 config section blocks
      - `workflow_prompt` string
      - `workflow_tools` string
      - `workflow_graph` string
      - `llm` string
      - `voice` string
      - `language` string
      - `call_handling` string
      - `detection` string
      - `analytics` string
      - `timeouts` string
      - `audio` string
      - `privacy` string
      - `widget` string
    - `workflowType` 'workflow_graph' | 'single_prompt' — The type of workflow configuration. workflow_graph uses a node-based visual workflow, single_prompt uses a simple prompt-based configuration.
    - `parentVersion` string, nullable — The version this was derived from
    - `isActive` boolean — Whether this is the currently active version for the agent
    - `createdBy` string — User ID of who created this record
    - `createdAt` string, date-time
    - `updatedAt` string, date-time

## Other responses

- `400` — Invalid input
- `401` — Unauthorized access
- `403` — Forbidden. Returned for workflow_graph agents when the organization lacks conversational agents access.
- `404` — Agent or version not found
- `500` — Internal server error

## Changes

- **2026-05-26** `5a6b4e19f353` — 5 info
  - added the non-success response with the status `403`
  - added the non-success response with the status `404`
  - added the optional property `data/activatedAt` to the response with the `200` status
  - added the optional property `data/activatedBy` to the response with the `200` status
  - …1 more
- **2026-04-20** `801f1d220d57` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/smallest-inc/apis/agent-management-api/changes/agent/:id/versions/:versionId/patch.md)

---

[API](https://skmtc.dev/smallest-inc/apis/agent-management-api.md) · [All operations](https://skmtc.dev/smallest-inc/apis/agent-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/smallest-inc/agent-management-api/revisions/ee98cf1af6bc/schema)