CreateWorkflowReq

Create a workflow from a blueprint, template, or from scratch. At minimum, provide blueprintKey to create from a blueprint, or provide envelopes and rootStep to create from scratch.

  • blueprintKey
    Type: string

    Key of the blueprint to instantiate (optional - for blueprint-based workflows)

  • blueprintVersion
    Type: string

    Version of the blueprint to use (optional - defaults to latest active version)

  • customFields
    Type: array object[] · CustomFieldConfig[]

    Custom fields for the workflow

    • key
      Type: string
      required

      Unique identifier for this custom field

    • name
      Type: string
      required

      Human-readable name for this custom field

    • value
      • Type: string

        Value for the custom field (can be literal or JSONata expression)

  • description
    Type: string

    Description of the workflow

  • entities
    Type: array object[]

    Entity data for the workflow

    • data
      Type: object
      required

      Entity data conforming to the schema

    • key
      Type: string
      required

      Entity key matching an entity slot

    • schemaKey
      Type: string
      required

      Schema key for the entity data

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

    Envelope configurations (for non-blueprint workflows)

    • 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
  • mode
    Type: stringenum

    Workflow creation mode - Run starts immediately, Review allows editing first

    values
    • Run
    • Review
  • name
    Type: string

    Human-readable name for the workflow

  • participantOverrides
    Type: array object[]

    Override participant info for blueprint-based workflows

    • email
      Type: string
      required

      New email for the participant

    • key
      Type: string
      required

      Participant key to override

    • name
      Type: string
      required

      New name for the participant

  • participants
    Type: array object[]

    Participants in the workflow

    • key
      Type: string
      required

      Unique key for this participant

    • email
      Type: string

      Email address of the participant

    • name
      Type: string

      Full name of the participant

  • rootStep
    Type: object · CreateWorkflowStep

    Root step of the workflow execution tree

    • 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.

  • senderInfo
    Type: object · SenderInfo

    Information about the sender

    • company
      Type: string

      Sender's company name

    • email
      Type: string

      Sender's email address

    • logoUrl
      Type: string

      URL to sender's logo

    • name
      Type: string

      Sender's name

    • phone
      Type: string

      Sender's phone number