---
title: "Archives a client-message template: it leaves lists (unless `includeArchived=true`) but the row stays so its history survives. Undo with restore. Other types are refused — their send and print paths (and settings pages) don't know about archiving."
method: POST
path: "/templates/{id}/archive"
tags: ["Templates"]
---

# Archives a client-message template: it leaves lists (unless \`includeArchived=true\`) but the row stays so its history survives. Undo with restore. Other types are refused — their send and print paths (and settings pages) don't know about archiving.

`POST /templates/{id}/archive`

## Request

- Base URL: `https://api.clinicos.vet/backend/business`
- URL: `https://api.clinicos.vet/backend/business/templates/{id}/archive`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/docs/templates/:id/archive/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `id` string, required

## Response `200`

OK

- TemplateResponseDto: Response DTO for a template.
  - `id` string
  - `name` string
  - `type` string
  - `logoUrl` string, nullable
  - `headerContent` string, nullable: Legacy field - kept for backward compatibility.
  - `footerContent` string, nullable: Legacy field - kept for backward compatibility.
  - `sections` TemplateSectionDto[], nullable: Block-based content sections.
    - `id` string
    - `type` string
    - `content` string
    - `order` union
      - integer
      - string, int32
    - `columns` TemplateSectionDto[], nullable
    - `widthPercent` union
      - number, double
      - string, double
  - `format` string, nullable
  - `emailSubject` string, nullable
  - `emailBody` string, nullable
  - `smsBody` string, nullable
  - `category` string, nullable: Client-message category key (type "client-message" only, ITE-1170).
  - `channel` string, nullable: Client-message channel: "email", "sms" or "both" (type "client-message" only).
  - `isDefault` boolean
  - `archivedAt` string, date-time, nullable: When the template was archived; null while active.
  - `createdById` string, nullable
  - `createdBy` UserSummaryDto
    - `id` string
    - `email` string
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `displayName` string, nullable
    - `type` string
    - `roleId` string, nullable
    - `roleName` string, nullable
  - `createdAt` string, date-time
  - `updatedAt` string, date-time
  - `unknownVariables` string[], nullable: Set on create/update responses only: {{tokens}} in the saved sections that the render pipeline will not substitute for this template's type (typos or variables from another template type). Null when everything is known or validation was not run.

## Other responses

- `404`: Not Found

## Changes

- **2026-10-28** `099cf36186e0`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/changes/templates/:id/archive/post.md)

---

[API](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1.md) - [All operations](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/revisions/099cf36186e0?raw)