---
id: workflow-update-metadata
title: "Update workflow metadata"
description: "Updates record-level fields (name, description, path, metadata) without creating a revision. At least one field is required."
sidebar_label: "Update workflow metadata"
hide_title: true
hide_table_of_contents: true
api: eJztWFFv2zgS/isDvjTJyXJu0cMe/OZ2W2wO2EPRTdEFusGaFkcWNxKpckZ2fIb/+2FIyVZqN1ksDrh9aB5iSeQMZz7OfJzhTrFekZp9Uh99uC9rvwGDpXWWrXek7jJlkIpgW3lXM/WhNZqRIGDhg5nUuMYaSou1IbhwusEMRgIZtJqrDBpkbTTrS9hYrnzHUATUbN0KNARcW7Le5TBnqFETg3eYlIKVpT53NqDJVaZ8i0GL5hujZmrTmzzrolWTYRmVqVYH3SBjEN92yortYovKlFipZsoalalBt5px6DBTVFTYaDXbKd62Mos4WLdS+y9xOKAVsMSArsAZaCAMawyTxjpGA9bAxWJT/pbn+eISfACuEAabXxAUtUXHk6LyhA7ucQsXtd9gKDQhUN2tMuic/dwhtBjAh5V29j/R+0vBAh9009Zi5Kb8zZYfXy0/lm23unZqf5c8Q+JX3mzFncI7RsfyqNu2tkXUM/2dxJvdqd9++TsWLEAGwZwtkowm7J5D58x4xP7cwGHPTtbeZ8qFc9riX6YIiy5Y3sYNXqIOGOadrPLpLgFArXeU7P7u+lp+Hu/hbYWQIscctqUPbMH3fwTZoDnOtBw3bIgelZ0IHyPyUwrRCHmmYsKgmcuc3ug5S34+Xs2aU8CeDJVM3eP2aRnd2IkJtuQJFdo5DHFrzkbCWGz+0w1EMRiJ/bk4Gaud6kKkJ5axoenBNhEep8jNGSC+GlHPhOER+zOWlT40mtVMRQpi26CIHLfoD4rsh7B++csvp6H6OlIFYAg+5CCBu/RmC6S3BJtKM2xkeBO8W81AuzQRFrLwIgMNVddoNwmojV7WCAuDrG0tQ85k4B2sdW1NBA5KbesuIGWRhtFx2CYCKkt0Rjg7UvMTKdIGv6yx+duZVOkT4F2acSb+T1OUWDujg+mdio5fvH/7Gr7/5/X30K8FySPKEgcb0ASLr9m0iPz5OHGSHad79dieN9EEmQMf3t9kgPkqh0XF3NJsOh1SfUJbYmxyg+tpNJqOQ87zpPSdM4vHHP6ndEik9ZA+lTL/9gyH+cSau5HLSg6rFYaxxMvrlzFXBdLnVB+pU852OfS+4BjAB0tMsrZ1spnFM+YeHKXpqBaZnqGuBMxImw5Bb0927V1Akvw4H+ez5+M8cs3zVP8HyIsYW5oKIU4L70rbkw+RXj2DStMRQ6XXeCiIoF99Cy8Kb/DFgUT2mfrHORb54PChxULOu1Sp9ITyLZO/ZfK3TP5LZnIqTSpvUv9SVGqokb4G7s6avZLqWBI8dT9dqEdxqVubu66u21qzVCJ54ZvYMgwF9c+S5AmHcVl9cEkUqb5Xkvc0SWX9w9uhuvnXx1slDkiivj+2I28GIIZ24mspevjcO3x4HxVrQ0k3KuWsK/25YptUpgSSpPw6/3t+fbLkq87WJoO2W9aWqgxC52KNBH4ZAT2kCEkISj83RvKYQOhW1mH+q/vVvfVdAGtQ09DCIXBlCebvbmYyYQJXVz8cN/DqCnTAR70iGF90DTqmHN6sMUjht0ZYYuEbJNDgumaJEkdXV0M3fXWVAXlwnitJAEuAQvi1J87TmvPaasJhPdkKA60XDgkE7EedOVzU9h5hUds1Li5zmBds13377kCLHlkgFqLcBUdgmYCDXa1El3f9im8esOgGJ1OjFa3aJpwlo2C5jb9Zz0Gu7Vgq0Y7Tg+xF7VfUa/wZi4BM8fNaByvVrSi/R2zljsGgY6vrNIGQxWYSbeDLCPExc/LYfnjiRrtRbKYLj+NWjO4YvuhlDkfo//uSpE9TxgeetrW2kWAjBwzE9unQlVL043jhk6mZNdJWVp5YJu52S034IdT7vXz+3GGQjvsuUwPekWKMJXk2albqmvAJcC7e96Zewl/gEuUsVsMR5OQAWuu6kzfVd8rSYu/v9pmqUBsM0fs08Dr5OLkV8aPgyeXBPhsk5kWBLT859250ALyb377+UXi2v9RpvBGhoOUiQf5HK32btnK2S992qtZu1cVjSSWlwsr6Mal/QeLRrbM47HZpxq2/R7ffH2BheRdk9vv/ApTiHqY=
sidebar_class_name: "patch api-method"
info_path: docs/api/workflows
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update workflow metadata"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/workflows/definitions/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Updates record-level fields (name, description, path, metadata) without creating a revision. At least one field is required.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"Workflow reference: a server-minted id (`wf_...`) or the workflow's client-chosen key (lowercase slug, unique per organization).","example":"wf_ifWBbWfpug0n"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"path":{"type":"string"},"metadata":{"type":"object"},"nrn":{"type":"string"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The updated workflow record.","content":{"application/json":{"schema":{"type":"object","properties":{"workflow":{"title":"Workflow","type":"object","required":["id","name","createdAt","updatedAt"],"properties":{"id":{"type":"string","example":"wf_ifWBbWfpug0n"},"key":{"type":"string","example":"ami-drift-scanner"},"name":{"type":"string","example":"AMI drift scanner"},"description":{"type":"string"},"path":{"type":"string","example":"/action-items/ami-drift"},"organizationId":{"type":"string"},"nrn":{"type":"string"},"metadata":{"type":"object"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}},"4XX":{"description":"Client error. The body says what went wrong: an error `type`, a human-readable `detail`, and, on validation failures, one entry per offending field.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}},"5XX":{"description":"Unexpected server error.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}}}}
>
  
</StatusCodes>