> ## Documentation Index
> Fetch the complete documentation index at: https://docs.quiva.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Unset template paths

> Remove specific fields from a **draft** template by dot-notation path.

NOTE: although this is a field-removal operation, the gateway routes it as **POST** `/file-generator/templates/{key}/unset` (the document equivalent is PATCH). Each path is unset as its own `type: unset` event on the template stream. Re-publish for the change to affect generation.



## OpenAPI

````yaml /api-reference/endpoint/documents/openapi.json post /file-generator/templates/{key}/unset
openapi: 3.1.0
info:
  title: Documents API
  description: >-
    Document templates, generated documents, e-signature requests, and checkbox
    approvals. Template and document routes are served under `/file-generator`,
    approval routes under `/workspaces/approvals`.
  version: 1.2.0
servers:
  - url: https://api.quiva.ai
    description: Production API server
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Templates
    description: >-
      Template lifecycle — create, read, publish, validate, trigger, and delete
      document templates. Templates follow a **draft → published** model: writes
      (`POST`, `PATCH`) always target the draft version, and `POST
      /templates/{key}/publish` promotes the draft. Document generation only
      ever uses the published version, so drafts can be edited safely without
      affecting production output. A template's `source` is a DOCX file
      containing angular-expression tags rendered at trigger time.
  - name: Documents
    description: >-
      Document lifecycle — read, update, and delete generated documents. A
      document record is created immediately when a template is triggered and is
      updated asynchronously: first with the generated `output.key` (an `obj://`
      or `kv://` storage URI) or `errors`, then with `signatures` progress as
      signatories sign.
  - name: Signatures
    description: >-
      E-signature workflows powered by HelloSign (Dropbox Sign). Signature
      requests are created automatically when a triggered template defines
      `signatories`. Each signatory tracks a status lifecycle of `DRAFT → SENT →
      SIGNED`, with `EXPIRED` (validity window elapsed) and `FAILED`
      (delivery/signing error) as terminal failure states. Embedded signing URLs
      can be generated for signatures created in embedded mode.
  - name: Approvals
    description: Checkbox approval of a workspace file, recorded as e-signature evidence.
  - name: Generation
  - name: Template Source
paths:
  /file-generator/templates/{key}/unset:
    post:
      tags:
        - Templates
      summary: Unset template paths
      description: >-
        Remove specific fields from a **draft** template by dot-notation path.


        NOTE: although this is a field-removal operation, the gateway routes it
        as **POST** `/file-generator/templates/{key}/unset` (the document
        equivalent is PATCH). Each path is unset as its own `type: unset` event
        on the template stream. Re-publish for the change to affect generation.
      operationId: unsetTemplatePaths
      parameters:
        - $ref: '#/components/parameters/TemplateKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnsetPathsRequest'
            example:
              key: invoice-template
              paths:
                - output.folder
                - signatories
      responses:
        '200':
          description: Paths unset successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessMessageResponse'
              example:
                message: success
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    TemplateKey:
      name: key
      in: path
      required: true
      description: Unique template key.
      schema:
        type: string
        example: invoice-template
  schemas:
    UnsetPathsRequest:
      type: object
      required:
        - key
        - paths
      properties:
        key:
          type: string
          description: Key of the record to modify.
          example: invoice-template
        paths:
          type: array
          items:
            type: string
          description: Dot-notation field paths to remove.
          example:
            - output.folder
            - signatories
    SuccessMessageResponse:
      type: object
      properties:
        message:
          type: string
          example: success
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          example: '"key" is required'
  responses:
    BadRequest:
      description: Invalid or missing request parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: '"key" is required'
    Unauthorized:
      description: Missing or invalid Authorization header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Authorization header with a bearer token is required
    ServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: server error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.