Restore a template

POST

/templates/:id/unarchive

POST

/templates/:id/unarchive

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

1 {
2   "template": {
3     "_id": "64b8f9a2e4b0c123456789ab",
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       "keywords": [
15         "contract",
16         "agreement"
17       ],
18       "confidence": 0.95
19     },
20     "scope": "library",
21     "actionDefinitionId": "act-9876543210",
22     "slug": "nda-template-v2",
23     "name": "NDA Template Version 2",
24     "description": "A non-disclosure agreement template for client engagements.",
25     "status": "draft",
26     "version": 1.1,
27     "file": {
28       "fileName": "nda_template_v2.docx",
29       "fileSize": 24576,
30       "fileType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
31     },
32     "binding": {
33       "customer_name": "string",
34       "effective_date": "date"
35     },
36     "variables": [
37       {
38         "name": "customer_name",
39         "type": "string",
40         "description": "Name of the customer"
41       }
42     ],
43     "lint": {
44       "errors": [],
45       "warnings": [
46         {
47           "code": "missing_alt_text",
48           "message": "Image missing alt text"
49         }
50       ]
51     },
52     "sampleData": {
53       "customer_name": "Acme Corporation",
54       "effective_date": "2024-06-01"
55     },
56     "archivedAt": null,
57     "createdAt": "2023-11-15T09:30:00Z",
58     "updatedAt": "2024-05-20T16:45:00Z",
59     "createdBy": "user_12345"
60   }
61 }

Restores an archived template to draft. Refuses with a slug conflict when another non-archived library template has since taken this template’s slug. Requires playbook:create.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

The restored (draft) template.

templateobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error