CreateBlueprintReq

  • envelopes
    Type: array object[] · BlueprintEnvelope[]
    required

    Array of envelopes containing documents

    • documents
      Type: array object[]
      required

      Documents within this envelope

    • key
      Type: string
      required

      Unique identifier for this envelope

    • subject
      Type: string
      required

      Slug for email template associated with this envelope

    • resolutionMode
      Type: stringenum

      When to resolve/render documents in this envelope

      values
      • immediate
      • just_in_time
  • key
    Type: string
    required

    Unique identifier for the blueprint within your organization

  • name
    Type: string
    required

    Human-readable name for the blueprint

  • rootStepKey
    Type: string
    required

    Key of the root step where the workflow begins

  • steps
    Type: array object[] · BlueprintStep[]
    required

    Array of workflow steps defining the orchestrated process

    • key
      Type: string
      required

      Unique identifier for this step

    • type
      Type: stringenum
      required

      Type of workflow step

      values
      • group
      • participant
    • action
      Type: object

      Action configuration (for participant steps)

    • childStepKeys
      Type: array string[]

      Array of child step keys (for group steps)

    • completionRule
      Type: stringenum

      Rule for determining when this step is complete (for group steps)

      values
      • all
      • any
      • quorum
    • executionMode
      Type: stringenum

      How child steps should be executed (for group steps)

      values
      • parallel
      • sequential
    • includeIf
      Type: string

      JSONata expression that determines whether this step should be included in the workflow

    • name
      Type: string

      Human-readable name for this step

    • onCompleteMappers
      Type: array object[]

      Data mappers that transform entity data when step completes

    • onCompleteValidationExpression
      Type: string

      JSONata expression to validate data when step completes

    • participantKey
      Type: string

      Participant key that this step is assigned to

    • quorumCount
      Type: integer

      Number of child steps required for quorum completion (when completionRule is 'quorum')

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

    Custom field configurations for the blueprint

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

  • inputs
    Type: array object[] · Input[]

    Array of inputs defining data requirements across all documents

    • key
      Type: string
      required

      Unique identifier for this input

    • schemaKey
      Type: string
      required

      Key of the schema that defines this entity's structure

    • description
      Type: string

      Description of what this input represents

    • name
      Type: string

      Human-readable name for this input

    • required
      Type: boolean

      Whether this entity slot must be populated

    • schemaDefinition
      Type: object

      Inline schema definition (optional)

    • schemaVersion
      Type: string

      Semantic version of the schema this is compatible with

  • labels
    Type: object

    Custom labels for categorization and filtering

    • propertyName
      Type: string
  • participants
    Type: array object[] · BlueprintParticipant[]

    Array of participants needed for this blueprint

    • isRequired
      required
      • Type: boolean

        Whether this participant is required (can be boolean or JSONata expression)

    • key
      Type: string
      required

      Unique identifier for this participant

    • name
      Type: string
      required

      Human-readable name for this participant

    • participantEmail
      Type: string

      Participant email (can be literal or JSONata expression)

    • participantName
      Type: string

      Participant name (can be literal or JSONata expression)

    • roleCategory
      Type: string

      Category or type of role (e.g., 'Signer', 'Reviewer')

  • status
    Type: stringenum

    Lifecycle status of the blueprint (defaults to Draft)

    values
    • Draft
    • Active