Sign in

fc954f96ea62

latestOpenAPI 3.0.0Apache 2.02026-07-267057121.5 KB

Update an existing workflow given its UUID.

patch/transform/v1/workflows/{id}

Path parameters

idstring required

UUID of the workflow to update.

Example:186522a6-e697-4e34-8498-eee961bcb845

UUID of the workflow to update.

Request body

descriptionstring

Updated description.

draftboolean

When true, the current version of the workflow will not be published.

namestring

New name for the workflow.

Example request

{
  "rescue": [
    {
      "action": "email.send",
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "next": [
        {
          "step_id": "186522a6-e697-4e34-8498-eee961bcb845"
        }
      ]
    }
  ],
  "steps": [
    {
      "action": "email.send",
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "next": [
        {
          "step_id": "186522a6-e697-4e34-8498-eee961bcb845"
        }
      ]
    }
  ]
}

Response

OK

countrystring

ISO country code the workflow will be used for.

created_atstring

When the workflow was created.

descriptionstring

Description of the workflow

disabledboolean

When true, this workflow can no longer be used.

draftboolean

When true, this workflow is still in draft mode and will not be used in jobs.

hashstring

Partial SHA256 hash of the workflow's contents.

idstring

The UUID (any version) of the workflow.

namestring

Name of the workflow

schemastring

Short schema name that the workflow will be allowed to process.

updated_atstring

When the workflow was last updated.

versionstring

Version of the workflow's contents currently defined.

Example response

{
  "id": "186522a6-e697-4e34-8498-eee961bcb845",
  "rescue": [
    {
      "action": "email.send",
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "next": [
        {
          "step_id": "186522a6-e697-4e34-8498-eee961bcb845"
        }
      ]
    }
  ],
  "steps": [
    {
      "action": "email.send",
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "next": [
        {
          "step_id": "186522a6-e697-4e34-8498-eee961bcb845"
        }
      ]
    }
  ]
}