UpdateTemplateReq

  • name
    Type: string
    required

    Updated display name for the template

  • description
    Type: string

    Updated description

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

    Updated array of fields

    • key
      Type: string
      required

      Unique identifier for the field

    • type
      Type: stringenum
      required

      Type of the field (form field or e-signature field)

      values
      • TextField
      • CheckBox
      • Image
      • Line
      • Signature
    • 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

    • valueExpression
      Type: string

      Optional JSONata expression to dynamically calculate field value from entity data

  • fileId
    Type: string

    Updated PDF file ID

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

    Updated array of inputs

    • 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

    Updated labels for categorization and filtering

    • propertyName
      Type: string
  • outputs
    Type: array object[] · Output[]

    Updated array of outputs

    • expression
      Type: string
      required

      JSONata expression to evaluate for producing the output data

    • key
      Type: string
      required

      Unique identifier for the output

    • roleKey
      Type: string
      required

      The key of the role this output belongs to

    • schemaKey
      Type: string
      required

      The schema key that defines the structure of this output

    • schemaVersion
      Type: string
      required

      The version of the schema

    • description
      Type: string

      Description of what this output represents

    • name
      Type: string

      Human-readable name for the output

  • roles
    Type: array object[] · TemplateRole[]

    Updated array of roles

    • isRequired
      Type: boolean
      required

      Whether this role must be assigned a participant when using the template

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

  • updatedAt
    Type: stringFormat: date-time

    Client-provided last updated timestamp for optimistic locking