Re-lint a template

POST

/templates/:id/lint

POST

/templates/:id/lint

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

1 {
2   "template": {
3     "_id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f9a1d23",
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       "detectedFields": [
15         "customer_name",
16         "order_date"
17       ]
18     },
19     "scope": "library",
20     "actionDefinitionId": "def12345-6789-4abc-9def-0123456789ab",
21     "slug": "invoice-template-2024",
22     "name": "Invoice Template 2024",
23     "description": "Template for generating customer invoices with dynamic data binding.",
24     "status": "draft",
25     "version": 1.1,
26     "file": {
27       "filename": "invoice_template.docx",
28       "size": 24576,
29       "checksum": "e3b0c44298fc1c149afbf4c8996fb924"
30     },
31     "binding": {
32       "customer_name": "{{ customer.name }}",
33       "order_date": "{{ order.date }}"
34     },
35     "variables": [
36       {
37         "name": "customer",
38         "type": "object",
39         "properties": {
40           "name": "string",
41           "address": "string"
42         }
43       }
44     ],
45     "lint": {
46       "errors": [],
47       "warnings": [
48         {
49           "message": "Unused variable 'address' in binding.",
50           "line": 12
51         }
52       ]
53     },
54     "sampleData": {
55       "customer": {
56         "name": "Jane Doe",
57         "address": "123 Maple Street"
58       },
59       "order": {
60         "date": "2024-06-01"
61       }
62     },
63     "archivedAt": null,
64     "createdAt": "2024-05-20T10:15:30Z",
65     "updatedAt": "2024-06-10T08:45:00Z",
66     "createdBy": "user_7890"
67   }
68 }

Refreshes a DOCX/Liquid template’s lint snapshot against its current bytes and binding (e.g. after the bound object changed). pdf-form rows have no Liquid to lint. Requires playbook:create.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

The re-linted template.

templateobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

503

Service Unavailable Error