> ## 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.

# Publish template

> Promote a draft template to published state. The published version is what `POST /templates/trigger` uses to generate documents — draft edits have no effect on generation until published.

Publishing copies the current draft aggregate to the published record; subsequent draft edits do not leak into the published version. Returns `400` if no draft exists for the key.



## OpenAPI

````yaml /api-reference/endpoint/documents/openapi.json post /file-generator/templates/{key}/publish
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}/publish:
    post:
      tags:
        - Templates
      summary: Publish template
      description: >-
        Promote a draft template to published state. The published version is
        what `POST /templates/trigger` uses to generate documents — draft edits
        have no effect on generation until published.


        Publishing copies the current draft aggregate to the published record;
        subsequent draft edits do not leak into the published version. Returns
        `400` if no draft exists for the key.
      operationId: publishTemplate
      parameters:
        - $ref: '#/components/parameters/TemplateKey'
      responses:
        '200':
          description: Template published successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubjectResponse'
              example:
                subject: ms.document.template.invoice-template
        '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:
    SubjectResponse:
      type: object
      properties:
        subject:
          type: string
          description: >-
            Messaging subject of the created or updated record. Formats: draft
            template `ms.document.draft.template.{key}`, published template
            `ms.document.template.{key}`, document `ms.document.document.{key}`
            — with keys sanitised into subject tokens (`/` → `.`, spaces → `_`,
            other special characters → `uXXXX` codes).
          example: ms.document.draft.template.invoice-template
    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.