UpdateWorkflowReq

All fields are optional - provide only the fields you want to update

  • description
    Type: string

    Description of the workflow

  • envelopes
    Type: array object[] · WorkflowEnvelope[]

    Updated envelope configurations

    • documents
      Type: array object[]
      required
    • key
      Type: string
      required

      Unique key for this envelope

    • subject
      Type: string
      required

      Email template slug

    • resolutionMode
      Type: stringenum

      When to resolve documents

      values
      • immediate
      • just_in_time
  • name
    Type: string

    Human-readable name for the workflow

  • participants
    Type: array object[] · ParticipantInfo[]

    Updated list of participants

    • key
      Type: string
      required
    • email
      Type: string
    • name
      Type: string
  • rootStep
    Type: object · CreateWorkflowStep

    Updated root step definition

    • key
      Type: string
      required

      Unique key for this step

    • type
      Type: stringenum
      required

      Type of step

      values
      • group
      • participant
    • action
      Type: object
    • children
      Type: array object[] · CreateWorkflowStep[]
    • completionRule
      Type: stringenum
      values
      • all
      • any
      • quorum
    • executionMode
      Type: stringenum
      values
      • sequential
      • parallel
    • includeIf
      Type: string
    • name
      Type: string
    • onCompleteMappers
      Type: array object[]
    • onCompleteValidationExpression
      Type: string
    • participantKey
      Type: string
    • quorumCount
      Type: integer

      Integer numbers.

  • updatedAt
    Type: stringFormat: date-time

    Client-provided last updated timestamp for optimistic locking