---
title: "Archive template"
method: POST
path: "/v1/templates/{id}/archive"
tags: ["Templates"]
---

# Archive template

`POST /v1/templates/{id}/archive`

## Request

- Base URL: `https://api.signvoy.com`
- URL: `https://api.signvoy.com/v1/templates/{id}/archive`
- Auth: one of:
  - API key in header `X-Workspace-Id`
  - HTTP bearer
  - HTTP bearer

## Path parameters

- `id` string, uuid, required

## Response `200`

- TemplateWithVersionsDto
  - `id` string, uuid, required
  - `workspaceId` string, uuid, required
  - `ownerId` string, required: Clerk user ID of the owner
  - `name` string, required
  - `kind` 'reusable' | 'oneoff', required: Reusable templates appear in the templates list. One-off templates back a single 'upload and send' document and are hidden from every listing.
  - `archivedAt` integer: Unix ms when archived (null if active)
  - `createdAt` integer, required
  - `updatedAt` integer, required
  - `currentDraftVersionId` string, uuid, nullable
  - `currentPublishedVersionId` string, uuid, nullable
  - `draftVersion` TemplateVersionDto
    - `id` string, uuid, required
    - `templateId` string, uuid, required
    - `version` integer, required
    - `status` 'draft' | 'published', required
    - `fileName` string, required: Original PDF file name
    - `pageCount` integer, required
    - `createdAt` integer, required: Creation timestamp (Unix ms)
    - `publishedAt` integer: Unix ms when published
    - `publishedBy` string: Clerk user ID of the publisher
    - `pdfUrl` string, uri: Presigned PDF URL (included when explicitly requested)
  - `publishedVersion` TemplateVersionDto
    - `id` string, uuid, required
    - `templateId` string, uuid, required
    - `version` integer, required
    - `status` 'draft' | 'published', required
    - `fileName` string, required: Original PDF file name
    - `pageCount` integer, required
    - `createdAt` integer, required: Creation timestamp (Unix ms)
    - `publishedAt` integer: Unix ms when published
    - `publishedBy` string: Clerk user ID of the publisher
    - `pdfUrl` string, uri: Presigned PDF URL (included when explicitly requested)

---

[API](https://skmtc.dev/signvoy/apis/signvoy-api.md) · [All operations](https://skmtc.dev/signvoy/apis/signvoy-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signvoy/apis/signvoy-api/revisions/003cabc7cfe2?raw)