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

# Touch Form Template

> Brings a **form template** up to date in place: converges any legacy-style
smart-tag anchors in the template's current version to the current hashed
identity format, addressed by the template's stable `FM-XXXX` number. The
request has no body.

**Idempotent.** A template that is already up to date reports
`changed: false` and nothing is written — so re-running a touch (or a whole
migration sweep) is safe, and a fleet-wide pass that reports `changed:
false` everywhere proves every anchor RESOLVABLE against the company's
current field configuration is converged. Anchors naming a field the
configuration does not define are deliberately left unrenamed (readable,
repairable) and do not count as changes.

The template's **content is never altered**: only the internal identity of
each smart-tag anchor changes; text and tag display names are preserved,
and no new version is created — unlike Replace Form Template, a touch
updates the current version's bytes without minting a checkpoint. Static
(PDF) forms have no smart-tag anchors and always report a clean no-op.

**Required permission:** `forms:update`




## OpenAPI

````yaml /openapi/generated-external-api.yaml post /api/v1/companies/{companyId}/forms/template/{number}/touch
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://go.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/companies/{companyId}/forms/template/{number}/touch:
    post:
      tags:
        - Forms
      summary: Touch Form Template
      description: >
        Brings a **form template** up to date in place: converges any
        legacy-style

        smart-tag anchors in the template's current version to the current
        hashed

        identity format, addressed by the template's stable `FM-XXXX` number.
        The

        request has no body.


        **Idempotent.** A template that is already up to date reports

        `changed: false` and nothing is written — so re-running a touch (or a
        whole

        migration sweep) is safe, and a fleet-wide pass that reports `changed:

        false` everywhere proves every anchor RESOLVABLE against the company's

        current field configuration is converged. Anchors naming a field the

        configuration does not define are deliberately left unrenamed (readable,

        repairable) and do not count as changes.


        The template's **content is never altered**: only the internal identity
        of

        each smart-tag anchor changes; text and tag display names are preserved,

        and no new version is created — unlike Replace Form Template, a touch

        updates the current version's bytes without minting a checkpoint. Static

        (PDF) forms have no smart-tag anchors and always report a clean no-op.


        **Required permission:** `forms:update`
      operationId: touchFormTemplate
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/formTemplateNumber'
      responses:
        '200':
          description: |
            The touch outcome. `changed` is true when the template's current
            version had legacy anchors that were converged.
          content:
            application/json:
              schema:
                type: object
                required:
                  - number
                  - changed
                  - renamedTags
                properties:
                  number:
                    type: string
                    description: The touched template's stable `FM-XXXX` number.
                  changed:
                    type: boolean
                    description: >-
                      True when the touch rewrote the template's current
                      version; false when it was already up to date.
                  renamedTags:
                    type: array
                    items:
                      type: string
                    description: >-
                      The legacy smart-tag identities that were converged to the
                      hashed format, one entry per unique identity. Empty when
                      the template was already converged.
              examples:
                converged:
                  summary: A legacy-anchor template was converged
                  value:
                    number: FM-0010
                    changed: true
                    renamedTags:
                      - AIIFmv1NamedInsured
                alreadyUpToDate:
                  summary: Nothing to do — the template was already up to date
                  value:
                    number: FM-0010
                    changed: false
                    renamedTags: []
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            No live form template carries the given number
            (`form-template-not-found`), or the template's current version
            exists but its stored file is missing from storage
            (`form-file-missing`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                notFound:
                  summary: Unknown number
                  value:
                    error:
                      code: form-template-not-found
                      message: No form template with number FM-0010 was found.
                      userMessages:
                        - No form template with number FM-0010 was found.
        '409':
          description: >-
            The stored file was modified while it was being touched. Nothing was
            overwritten — retry the touch.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                concurrentModification:
                  summary: File changed mid-touch
                  value:
                    error:
                      code: form-file-concurrently-modified
                      message: >-
                        The form was modified while it was being touched. Retry
                        the touch.
                      userMessages:
                        - >-
                          The form was modified while it was being touched.
                          Retry the touch.
        '422':
          description: >-
            The stored file could not be parsed as a `.docx`, so its smart tags
            cannot be converged.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unreadable:
                  summary: Stored bytes are not a readable .docx
                  value:
                    error:
                      code: form-file-unreadable
                      message: >-
                        The form’s stored file could not be read as a .docx, so
                        it cannot be touched.
                      userMessages:
                        - >-
                          The form’s stored file could not be read as a .docx,
                          so it cannot be touched.
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
    formTemplateNumber:
      name: number
      in: path
      required: true
      schema:
        type: string
      description: >
        The form template's stable `FM-XXXX` number (as returned by the Upload
        Form

        Template endpoint). It identifies the template across all of its
        versions and

        is the same value forms-logic rules reference.
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: AuthenticationError
                  message: API key authentication required
                  userMessages:
                    - API key authentication required
            invalidApiKey:
              summary: >-
                Invalid API key (e.g. unknown key, or a Bearer token used
                instead of an API key)
              value:
                error:
                  code: AuthenticationError
                  message: Invalid API key
                  userMessages:
                    - Invalid API key
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: AuthorizationError
                  message: User is not authorized to perform the requested action
                  userMessages:
                    - User is not authorized to perform the requested action
            companyMismatch:
              summary: A valid API key naming another company in the URL
              value:
                error:
                  code: AuthorizationError
                  message: API key is not scoped to the requested company
                  userMessages:
                    - API key is not scoped to the requested company
  schemas:
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error message
              example: 'submissionId: Required field is missing'
            userMessages:
              type: array
              description: >-
                Clean, verbatim-displayable messages — one entry per failure,
                free of error-code tags, field paths, and internal noise.
                Suitable for showing to end users as-is.
              items:
                type: string
              example:
                - Exposures of type 'company' require an address
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Send your raw API key as the `Authorization`
        header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do
        NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key`
        header; those are not accepted.

````