STstuut
workflows

Update Workflow

Update a workflow's metadata, trigger configuration, and action configurations.

patch/v2/workflows/{workflow_id}

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

workflow_idstring required

Request body

namestring required
descriptionstring nullable
business_unit_idstring nullable
workflow_group_idstring typeid nullable

TypeID identifier

segment_idsstring[]

Customer segments the workflow is restricted to; empty means unrestricted.

segment_matching_mode'any' | 'highest_priority'
action_execution_strategy'sequential' | 'parallel' | 'percentage'

Response

Successful Response

created_atstring date-time required
modified_atstring date-time nullable required
idstring required
namestring required

Admin-facing workflow name.

descriptionstring nullable required

Optional notes describing the workflow purpose.

status'draft' | 'paused' | 'finished' | 'active' required
action_execution_strategy'sequential' | 'parallel' | 'percentage' required
segment_matching_mode'any' | 'highest_priority'
business_unit_idstring nullable required

Optional business unit assigned to this workflow.

workflow_group_idstring nullable required

Optional collection coordinating independent workflows.

validation_errorsstring[] required
objectstring required

String representing the object's type. Objects of the same type share the same value.

Changes

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