Activate a template

POST

/templates/:id/activate

POST

/templates/:id/activate

1 curl -X POST https:/https://api/templates/id/activate \
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       "type": "regex",
15       "pattern": "\\bInvoice\\b"
16     },
17     "scope": "library",
18     "actionDefinitionId": "act-9f8b7c6d5e4a3b2c1d0e",
19     "slug": "invoice-template-2024",
20     "name": "Invoice Template 2024",
21     "description": "A template for generating customer invoices with dynamic fields.",
22     "status": "active",
23     "version": 1.1,
24     "file": {
25       "fileName": "invoice_template.docx",
26       "fileSize": 24576,
27       "fileType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
28     },
29     "binding": {
30       "recordType": "invoice",
31       "fields": {
32         "customer_name": "string",
33         "invoice_date": "date",
34         "total_amount": "number"
35       }
36     },
37     "variables": [
38       {
39         "name": "customer_name",
40         "type": "string",
41         "description": "Name of the customer"
42       }
43     ],
44     "lint": {
45       "errors": [],
46       "warnings": []
47     },
48     "sampleData": {
49       "customer_name": "Acme Corporation",
50       "invoice_date": "2024-06-15",
51       "total_amount": 1234.56
52     },
53     "archivedAt": null,
54     "createdAt": "2024-05-01T10:15:30Z",
55     "updatedAt": "2024-06-10T08:45:00Z",
56     "createdBy": "user_7a8b9c0d1e2f3g4h5i6j"
57   }
58 }

Transitions a draft template to active. The bound record type must still resolve and the recomputed lint snapshot must carry zero errors. Requires playbook:create.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

The activated template.

templateobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error