Workflows

Update a workflow version name

Updates the name of an existing version.

Names are validated against the pattern: length 2-20 characters, alphanumerics plus ., _, -. Duplicate names within the same workflow template are allowed.

patch/v1/workflow-templates/{id}/versions/{versionId}

Request

  • Base URL
    https://api.emma.ms/external
  • Auth
    HTTP bearer

Path parameters

idinteger required

ID of the workflow template

versionIdinteger required

ID of the workflow template version

Request body

namestring required

New name for the workflow version. Length 2–20 characters. Allowed characters — alphanumerics, ., _, -.

Example request

{
  "name": "MongoDB-8.3"
}

Response

Workflow version name updated successfully

idinteger required

ID of the version.

namestring required

Name of the version.

createdAtstring required

Date and time of the version creation.

createdByIdinteger required

ID of the user or service application that initiated creation of the version.

createdByNamestring required

Name of the user or service application that initiated creation of the version.

isActiveboolean required

Indicates whether the version is active.

secretsChangedboolean required

Indicates whether the secrets were changed in this version.

sequenceNumberinteger required

A sequential number assigned to each version in creation order.

restoredFrominteger nullable

ID of the source version. Present only if this version was created by restoring another version; null otherwise.

restoredFromNamestring nullable

Name of the source version. Present only if this version was created by restoring another version; null otherwise.

Example response

{
  "id": 123,
  "name": "v1",
  "createdAt": "2026-11-26T14:54:11",
  "createdById": 543,
  "createdByName": "Automation User",
  "sequenceNumber": 7,
  "restoredFrom": 123,
  "restoredFromName": "v11"
}

Changes

No recorded changes to this operation across all 1 revision of this API.