JUjumpcloud
Workflows

Update a workflow

Update an existing workflow by its ID

put/api/v2/workflows/{id}

Request

Path parameters

idstring required

Workflow ID

Request body

namestring

Name of the workflow

descriptionstring

Description of the workflow

dslobject required

JSON definition of the workflow DSL

status'active' | 'inactive'

Status of the workflow

execution_role_idstring

Role ID used to identify the workflow execution. Optional for normal updates; required when updating a legacy workflow that does not yet have an execution role.

Response

Workflow updated successfully

idstring

Unique identifier of the workflow

namestring

Name of the workflow

descriptionstring

Description of the workflow

dslobject

JSON definition of the workflow DSL

statusstring

Status of the workflow

trigger_typestring

Type of the workflow trigger. Possible values: jc_events, external, scheduler.

execution_role_idstring nullable

Role ID used to identify the workflow execution. Currently optional as part of the rollout. (null/omitted for legacy workflows)

last_ranstring date-time nullable

Timestamp when the workflow was last executed

created_bystring

Identifier of the user who created the workflow

created_atstring date-time

Timestamp when the workflow was created

updated_atstring date-time

Timestamp when the workflow was last updated

Changes

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