---
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: >-
  eJztV1Fv2zYQ/isHvjTBZNkbOnTQmxu0WAasCLIEKRAENS2eLDYSqZKUHdfQfx+OlGQlVuKiGLA+NA+OKPKOd9/dd7rbMcdXliW37Eab+6zQGxCYSSWd1Mqyu4gJtKmRFa1Zwq4rwR1aMJhqIyYFrrGATGIhLJwoXmIEA4EIKu7yCEp0XHDHT2EjXa5rB6lB7qRaAQeDa2mlVjHMHRTIrQOtMCgFSVd9qaVBEbOI6QoNJ83ngiVs05qc1N6qSXcNi1jFDS/RoSHfdkyS7WQLixhZyRImBYtYp5slztQYMZvmWHKW7JjbVnTKOiPVijVPcejRMpihQZViAhwsmjWaSSmVQwFSwMlik32K43hxCtqAyxE6m19ZSAuJyk3SXFtUcI9bOCn0Bk3KLYIt6lUEtZJfaoQKDWiz4kp+9d6fEhb4wMuqICM32SeZ3bxd3mRVvZop1twFz9C6t1psyZ1UK4fK0SOvqkKmXs/0syVvdod+6+VnTB0BaQhzJ9HSbsDuGDoj+x77sY0+Zgd3NxFTZkyb/4uYxbQ20m19gJfIDZp5Tbfc3gUAbKWVDXb/NpvRv8cxvMoRQuaIPixtYhO+/xFknWZ/UjofsC57WHQgvM/I25CiHvKIecKgmNOZ1ui5I34+vk2KQ8BeTJWI3eP2ZRleyokwMnMTm3Kl0PjQjGbCUGz+9zl4MRiIfV+eDNVOeUrSE+mwtNPeNhIeUuR8BIhnM+pIGu6xH7Es06bkjiXMlyAnSySRfYi+UaTp0vr1x4+HqXrmSwWgMdrEQIm71GILlm8tbHLuYEPbG6PVKgGuwkFY0MWLCDjkdcnVxCAXfFkgLAQ6LgvaUiICrWDNCyk8cJBxWdQGbeTLMCpntqEAZRkqQTXbl+YXKFIZvSyw/GWEKi0BLsKJkfw/pKh1XAluROuUd/zk8v0ZvPlj9gbauyB4ZKNQgwVwC4vnbFr4+vmYOMGOw1g9tuedN4HOwPXleQQYr2JY5M5VNplOO6pP7NY6LGOB66k32u63lHaTTNdKLB7X8O/SQZnWQvoSZT5oB/1567irBy4z+lit0AwlXs9ee64SpMdU70snfdvpo/ekxgA+SOss3S0VBTM9Ym7vqJ0OepHpSOkKwAy0cWP49iBqFwYt8WM8z5Pjee5rzfFS/w3Fyzqs7JQK4jTVKpNt8bGWr46gUtbWQc7X2DdE0N6+hVepFviqLyJNxH4fqyLXCh8qTOl7FzqVtqD8ZPJPJv9k8g/J5NCa5FqE+SXNWdcjPQfuToqGUXdMBA/TT22KQV7ySsaqLoqq4I46kTjVpR8Zuob6HyJ5wGHYVvcukSLWzkq0DodY1D6877qbv26uGDlARL3cjyPvOiC6ceI5ivavW4f79aBZ61q6QSsnVaZJObkfFP0az+IZ6wnGPgy8h/nFuW88tXUlVwOrwqi7J8VgunzSxfbF8/8ej9sAOXxw06rg0lPLR79L6dt+HrHej/2oH7FEChoocm0dHdztltzitSmahl5/qdHQrHUXsTU3kvpIn1xCWnoWLMl4YfEFcE4uW1NP4QcYn0ex6oqPotKz5kVNK9bOSDRcNXdNxHLkAo33PmycBR8nVyS+FzwYG5uok5inKVbuxbN3A+pfzK/O/iSGteN8qQUJGU4jJP16K3UVQpnswrsdK7ha1b4gsaCU+Mgf0/kJfb1bozjsduHElb5H1TQ9LI7WhEzT/Auc6mXT
sidebar_class_name: patch api-method
info_path: docs/api/nullplatform-api
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/workflow-update-metadata'
---
<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>