Update Metronome version

PATCH/v1/metronomes/{metronomeId}/versions/{versionId}

Describe or update the definition for a saved workflow version. Version labels are server-generated and immutable; published versions are immutable.

How to call this endpoint

Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.

Path, query, and header parameters

These parameters control which ACP object the endpoint acts on and how the request is processed.

Path parameters
NameLocationTypeRequiredDescription
metronomeIdpathstringYesMetronome workflow ID
versionIdpathstringYesMetronome workflow version ID
Query parameters
None.

Body schema

Content type: application/json · Optional

FieldTypeRequiredDescription
labelstringNoDeprecated. Version labels are immutable and generated by the server.
namestringNoDeprecated. Version names are immutable and generated by the server.
descriptionstringNoHuman-readable description.
definitionobjectNo
definition.nodesobject[]No
definition.nodes[].idstringNoUnique identifier.
definition.nodes[].typestringNo
definition.nodes[].positionobjectNo
definition.nodes[].dataobjectNo
definition.nodes[].data.kindtrigger | condition | action | imagine | function | database | ticket | metronome | loop | end | noteNo
definition.nodes[].data.subtypestringNo
definition.nodes[].data.labelstringNo
definition.nodes[].data.descriptionstringNoHuman-readable description.
definition.nodes[].data.configobjectNo
definition.edgesobject[]No
definition.edges[].idstringNoUnique identifier.
definition.edges[].sourcestringNo
definition.edges[].targetstringNo
definition.edges[].sourceHandlestringNo
definition.edges[].targetHandlestringNo
definition.edges[].labelstringNo
definition.executionRecoveryPolicyobjectNo
definition.executionRecoveryPolicy.schemaVersioncomputer_agents_metronome_recovery_policy_v1Yes
definition.executionRecoveryPolicy.enforcementcheckpointedYes
definition.executionRecoveryPolicy.inDoubtDefaultpauseYes
definition.executionRecoveryPolicy.checkpointMaxBytesintegerYes

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Metronome version updatedapplication/json
FieldTypeRequiredDescription
dataobjectNo
data.idstringNoUnique identifier.
data.metronomeIdstringNo
data.userIdstringNoUser ID.
data.versionintegerNoZero-based immutable version number. The first version is v0.
data.versionNumberintegerNoAlias of version.
data.labelstringNoServer-generated canonical label in vN form.
data.namestringNoAlias of label.
data.descriptionstringNoHuman-readable description.
data.statussaved | published | archivedNoCurrent lifecycle status.
data.storageStatussaved | published | archivedNo
data.definitionobjectNo
data.definition.nodesobject[]No
data.definition.nodes[].idstringNoUnique identifier.
data.definition.nodes[].typestringNo
data.definition.nodes[].positionobjectNo
data.definition.nodes[].dataobjectNo
data.definition.nodes[].data.kindtrigger | condition | action | imagine | function | database | ticket | metronome | loop | end | noteNo
data.definition.nodes[].data.subtypestringNo
data.definition.nodes[].data.labelstringNo
data.definition.nodes[].data.descriptionstringNoHuman-readable description.
data.definition.nodes[].data.configobjectNo
data.definition.edgesobject[]No
data.definition.edges[].idstringNoUnique identifier.
data.definition.edges[].sourcestringNo
data.definition.edges[].targetstringNo
data.definition.edges[].sourceHandlestringNo
data.definition.edges[].targetHandlestringNo
data.definition.edges[].labelstringNo
data.definition.executionRecoveryPolicyobjectNo
data.definition.executionRecoveryPolicy.schemaVersioncomputer_agents_metronome_recovery_policy_v1Yes
data.definition.executionRecoveryPolicy.enforcementcheckpointedYes
data.definition.executionRecoveryPolicy.inDoubtDefaultpauseYes
data.definition.executionRecoveryPolicy.checkpointMaxBytesintegerYes
data.nodesobject[]No
data.nodes[].idstringNoUnique identifier.
data.nodes[].typestringNo
data.nodes[].positionobjectNo
data.nodes[].dataobjectNo
data.nodes[].data.kindtrigger | condition | action | imagine | function | database | ticket | metronome | loop | end | noteNo
data.nodes[].data.subtypestringNo
data.nodes[].data.labelstringNo
data.nodes[].data.descriptionstringNoHuman-readable description.
data.nodes[].data.configobjectNo
data.edgesobject[]No
data.edges[].idstringNoUnique identifier.
data.edges[].sourcestringNo
data.edges[].targetstringNo
data.edges[].sourceHandlestringNo
data.edges[].targetHandlestringNo
data.edges[].labelstringNo
data.triggerSummarystringNo
data.nodeCountintegerNo
data.edgeCountintegerNo
data.publishedAtstringNo
data.createdAtstringNoISO 8601 timestamp.
data.updatedAtstringNoISO 8601 timestamp.
400Invalid version update or immutable published version
None.
404Metronome or version not found
None.
Update Metronome version
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow