BlueprintEnvelope

  • documents
    Type: array object[]
    required

    Documents within this envelope

    • key
      Type: string
      required

      Unique identifier for this document

    • name
      Type: string
      required

      Human-readable name for this document

    • fileId
      Type: string

      File ID for uploaded document (alternative to template)

    • includeIf
      Type: string

      JSONata expression for conditional inclusion

    • inputMapping
      Type: array object[]

      Mappings between template inputs and blueprint inputs

    • iterator
      Type: string

      JSONata expression for iterating over entities

    • templateKey
      Type: string

      Key of the template to use (optional if using fileId)

    • templateVersion
      Type: string

      Version of the template to use

  • 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