Archive a template

POST

/templates/:id/archive

POST

/templates/:id/archive

1 curl -X POST https:/https://api/templates/id/archive \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "template": {
3     "_id": "64b8f9e2a1c4d23f9b7e4d12",
4     "kind": "docx-liquid",
5     "formModality": "pdf-acroform",
6     "formFields": [
7       {
8         "fieldName": "customer_name",
9         "fieldType": "text",
10         "required": true
11       }
12     ],
13     "detection": {
14       "enabled": true,
15       "method": "keyword"
16     },
17     "scope": "library",
18     "actionDefinitionId": "5f8d0d55b54764421b7156c3",
19     "slug": "customer-agreement-template",
20     "name": "Customer Agreement",
21     "description": "Template for customer agreement documents.",
22     "status": "archived",
23     "version": 1.1,
24     "file": {
25       "fileName": "customer_agreement_v1.docx",
26       "fileSize": 24576,
27       "fileType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
28     },
29     "binding": {
30       "customer_name": "{{ customer.name }}",
31       "agreement_date": "{{ agreement.date }}"
32     },
33     "variables": [
34       {
35         "name": "customer_name",
36         "type": "string",
37         "description": "Name of the customer"
38       }
39     ],
40     "lint": {
41       "errors": [
42         {
43           "code": "missing_variable",
44           "message": "Variable 'agreement_date' is not defined in the template."
45         }
46       ],
47       "warnings": [
48         {
49           "code": "deprecated_syntax",
50           "message": "Use of deprecated syntax in variable 'customer_name'."
51         }
52       ]
53     },
54     "sampleData": {
55       "customer_name": "Acme Corp",
56       "agreement_date": "2024-06-01"
57     },
58     "archivedAt": "2024-06-10T09:15:00Z",
59     "createdAt": "2024-01-15T12:00:00Z",
60     "updatedAt": "2024-06-10T09:15:00Z",
61     "createdBy": "user_12345"
62   }
63 }

Archives a draft or active template. Archiving refuses nothing — pinned actions keep rendering retained versions. Requires playbook:create.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

idstringRequired

Response

The archived template.

templateobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error