> ## 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. # Replace Form Template > Replaces an existing **DOCX template's** content in place, addressed by its stable `FM-XXXX` `number`. The uploaded file becomes a new version under the SAME template — same `number`, `templateKey`, display name, and category — so the template's identity is unchanged and **forms-logic rules (which reference the number) keep working**. Use this to correct or update an existing template without re-pointing the rules that depend on it. **Same-type only.** The target `number` must be a `.docx` template and the replacement must be `.docx`; a static PDF form is replaced via `PUT /forms/static/{number}`. This prevents a replace from silently flipping a form's file type under the same number. Validation otherwise matches Upload Form Template: every embedded smart tag must resolve to an available, smart-tag-enabled field for the template's category, named by its current hashed identity (the retired legacy `AIIFmv1` naming is rejected with an error naming the replacement) — otherwise the **entire replace is rejected** with a per-tag `400` and no new version is written. `category` is **not** part of the request — a replace never re-scopes; the new content is validated against the template's existing category. **Required permission:** `forms:update` ## OpenAPI ````yaml /openapi/generated-external-api.yaml put /api/v1/companies/{companyId}/forms/template/{number} 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}: put: tags: - Forms summary: Replace Form Template description: > Replaces an existing **DOCX template's** content in place, addressed by its stable `FM-XXXX` `number`. The uploaded file becomes a new version under the SAME template — same `number`, `templateKey`, display name, and category — so the template's identity is unchanged and **forms-logic rules (which reference the number) keep working**. Use this to correct or update an existing template without re-pointing the rules that depend on it. **Same-type only.** The target `number` must be a `.docx` template and the replacement must be `.docx`; a static PDF form is replaced via `PUT /forms/static/{number}`. This prevents a replace from silently flipping a form's file type under the same number. Validation otherwise matches Upload Form Template: every embedded smart tag must resolve to an available, smart-tag-enabled field for the template's category, named by its current hashed identity (the retired legacy `AIIFmv1` naming is rejected with an error naming the replacement) — otherwise the **entire replace is rejected** with a per-tag `400` and no new version is written. `category` is **not** part of the request — a replace never re-scopes; the new content is validated against the template's existing category. **Required permission:** `forms:update` operationId: replaceFormTemplate parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/formTemplateNumber' requestBody: required: true content: application/json: schema: type: object required: - fileName - fileBase64 properties: fileName: type: string description: > Original file name of the replacement, including the `.docx` extension (used only for extension detection — the template's display name is preserved). Must be non-empty. fileBase64: type: string description: The raw `.docx` bytes of the new version, base64-encoded. examples: correctedTemplate: summary: Replace a template with a corrected DOCX value: fileName: certificate-corrected.docx fileBase64: UEsDBBQABgAIAAAAIQ... responses: '200': description: > New version created. The response is the new checkpoint's summary — note `number` and `templateKey` are unchanged from the previous version. content: application/json: schema: $ref: '#/components/schemas/Fmv1FormTemplateSummary' examples: success: summary: Replaced template (new version) value: templateKey: 550e8400-e29b-41d4-a716-446655440040 checkpointId: 550e8400-e29b-41d4-a716-446655440042 companyId: 550e8400-e29b-41d4-a716-446655440000 name: Certificate of Insurance number: FM-0010 category: event storagePath: >- acme/550e8400-.../formTemplates/550e8400-.../V-001/550e8400-....docx createdAt: '2026-07-01T12:00:00.000Z' createdBy: 550e8400-e29b-41d4-a716-446655440099 updatedAt: '2026-07-01T12:00:00.000Z' updatedBy: 550e8400-e29b-41d4-a716-446655440099 '400': description: > Bad Request — the target form is not a `.docx` template (`form-template-type-mismatch`), the uploaded file is not `.docx`, a field is missing/invalid, or one or more embedded smart tags are invalid (`details` lists one entry per offending tag). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: typeMismatch: summary: Target number is a static PDF, not a DOCX template value: error: code: form-template-type-mismatch message: >- form template FM-0010 is a .pdf form; the template-replace endpoint only replaces .docx templates userMessages: - >- Form FM-0010 is not a .docx template. Use the static-form replace endpoint for PDF forms. notDocx: summary: Replacement file is not DOCX value: error: code: external-form-upload-docx-only message: >- Only .docx form templates can be uploaded through the API. Convert the file to .docx and try again. userMessages: - >- Only .docx form templates can be uploaded through the API. Convert the file to .docx and try again. invalidSmartTags: summary: Embedded smart tags not valid for the template's category value: error: code: invalid-smart-tags message: >- Uploaded form references smart tags that are not valid for the selected category. details: - field: smartTags.AIIFmv1Missing message: >- "AIIFmv1Missing" does not match any smart tag available for this form category. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: No live form template carries the given number. 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. '500': $ref: '#/components/responses/InternalServerError' 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. schemas: Fmv1FormTemplateSummary: type: object description: A single form-template checkpoint. required: - templateKey - checkpointId - companyId - name - number - category - storagePath - createdAt - updatedAt properties: templateKey: type: string format: uuid description: Stable identifier of the template across its versions. checkpointId: type: string format: uuid description: Identifier of this specific checkpoint (version) of the template. companyId: type: string format: uuid name: type: string description: Display name (derived from the uploaded file name). number: type: string description: Human-facing form number (e.g. `FM-0010`). category: type: string enum: - event - quote-flow - quote-bind-flow - unknown description: The form category assigned to the template. storagePath: type: string description: Internal storage key of the checkpoint's document. createdAt: type: string format: date-time createdBy: type: string nullable: true updatedAt: type: string format: date-time updatedBy: type: string nullable: true 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 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 InternalServerError: description: Internal Server Error - Unexpected error occurred content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internalError: summary: Unexpected server error value: error: code: UncaughtActionError message: Uncaught error occurred in userMessages: - An unexpected error occurred. Please try again later. 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. ````