Replace a template file

PUT

/templates/:id/file

PUT

/templates/:id/file

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

1 {
2   "template": {
3     "_id": "a3f1c9d2-4b7e-4f9a-9c3d-2e5b7f8a1d23",
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       "engine": "liquid",
15       "version": "1.0.3"
16     },
17     "scope": "library",
18     "actionDefinitionId": "def12345-6789-4abc-def0-1234567890ab",
19     "slug": "customer-agreement-template",
20     "name": "Customer Agreement",
21     "description": "Template for customer agreement documents with dynamic fields.",
22     "status": "draft",
23     "version": 2,
24     "file": {
25       "filename": "customer_agreement_v2.docx",
26       "size": 24576,
27       "checksum": "e3b0c44298fc1c149afbf4c8996fb924"
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       "warnings": [
43         {
44           "code": "deprecated_syntax",
45           "message": "Use of deprecated Liquid syntax detected in line 12."
46         }
47       ]
48     },
49     "sampleData": {
50       "customer_name": "Jane Doe",
51       "agreement_date": "2024-06-01"
52     },
53     "archivedAt": null,
54     "createdAt": "2024-05-10T09:15:00Z",
55     "updatedAt": "2024-06-01T14:45:00Z",
56     "createdBy": "user_7890"
57   }
58 }

Replaces a DOCX/Liquid template’s file: re-lints, writes an immutable v{n+1} R2 object, and bumps the version (old version objects are retained for pinned actions). A pdf-form row replaces its file via POST /:id/form-file instead. Requires playbook:create.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

The updated template.

templateobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

503

Service Unavailable Error