WorkflowEnvelope

  • documents
    Type: array object[]
    required
    • key
      Type: string
      required
    • adhocFields
      Type: array object[]
      Empty object
    • fieldOverrides
      Type: array object[]
      Empty object
    • fileId
      Type: string Pattern: ^f_[0-9a-z]{26}$

      Prefixed lowercase ULID, e.g. f_01jv8m7qfj6xj9gkz7a4s2h8e.

    • includeIf
      Type: string
    • inputMap
      Type: array object[]
    • iterator
      Type: string
    • templateKey
      Type: string
    • templateVersion
      Type: string
  • key
    Type: string
    required

    Unique key for this envelope

  • subject
    Type: string
    required

    Subject line used in email notifications sent to participants for this envelope. Free-form text — what recipients see in their inbox.

  • resolutionMode
    Type: stringenum

    When the envelope's documents are materialized. immediate (default) renders at workflow creation; just_in_time renders right before the participant signs, picking up any entity data updated by earlier steps.

    values
    • immediate
    • just_in_time