RenderTemplateReq

fields
Type: array object[] · TemplateFieldInfo[]
required

Array of fields to populate in the template
- key
  Type: string
  required
  
  Unique identifier for the field
- type
  Type: stringenum
  required
  
  Type of the field (form field or e-signature field)
  
  values
  text_field
  check_box
  image
  line
  signature
  initial
  signed_date
- widgets
  Type: array object[]
  required
  
  Visual elements representing this field in the PDF
- assignment
  Type: object
  
  Assignment for the field, indicating which participant should fill this field
- includeIf
  Type: string
  
  Optional JSONata expression to control field visibility
- value
  
  Optional literal value or JSONata expression to dynamically calculate field value from entity data
  
  Type: string
  
  Optional literal value or JSONata expression to dynamically calculate field value from entity data
fileId
Type: string Pattern: ^f_[0-9a-z]{26}$
required

ID of the PDF file to render. Prefixed lowercase ULID, e.g. f_01jv8m7qfj6xj9gkz7a4s2h8e.
inputs
Type: array object[]
required

Inputs with their schema mappings
- key
  Type: string
  required
  
  Entity slot key
- required
  Type: boolean
  required
  
  Whether this entity slot is required
- schemaKey
  Type: string
  required
  
  Schema key for this entity
scenarioKey
Type: string
required

Scenario key for data resolution
isPreview
Type: boolean

Whether this is a preview render
roles
Type: array object[] · TemplateRole[]

Roles for e-signature workflow
- key
  Type: string
  required
  
  Unique identifier for the role
- name
  Type: string
  
  Human-readable name for the role
- roleCategory
  Type: string
  
  Category or type of role (e.g., 'Signer', 'Approver')