Update a template

PATCH

/templates/:id

PATCH

/templates/:id

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

1 {
2   "template": {
3     "_id": "tmpl_9f8b7c6d5e4a3b2c1d0e",
4     "kind": "docx-liquid",
5     "formModality": "pdf-acroform",
6     "formFields": [
7       {}
8     ],
9     "detection": {},
10     "scope": "library",
11     "actionDefinitionId": "act_1234567890abcdef",
12     "slug": "employee-onboarding-template",
13     "name": "Employee Onboarding Document",
14     "description": "Template for onboarding new employees, including contract and policy acknowledgments.",
15     "status": "draft",
16     "version": 1.1,
17     "file": {},
18     "binding": {},
19     "variables": [
20       {}
21     ],
22     "lint": {
23       "errors": [
24         {}
25       ],
26       "warnings": [
27         {}
28       ]
29     },
30     "sampleData": {},
31     "archivedAt": "null",
32     "createdAt": "2024-05-10T09:15:00Z",
33     "updatedAt": "2024-06-01T12:00:00Z",
34     "createdBy": "user_7a8b9c0d1e2f3g4h5i6j"
35   }
36 }

Patches a template’s name, description, binding, or sample data (the slug is immutable). A binding change on a DOCX/Liquid template re-lints and bumps the version. Requires playbook:create.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

namestringOptional1-200 characters

descriptionstringOptional<=5000 characters

bindingobjectOptional

sampleDatamap from strings to any or nullOptional

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