Create a template

POST

/templates

POST

/templates

1 curl -X POST https:/https://api/templates \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: multipart/form-data" \
4      -F file=@employee_onboarding_template.docx \
5      -F name="Employee Onboarding Template"

1 {
2   "template": {
3     "_id": "64b8f9a2e4b0c123456789ab",
4     "kind": "docx-liquid",
5     "formModality": "pdf-acroform",
6     "formFields": [
7       {}
8     ],
9     "detection": {},
10     "scope": "library",
11     "actionDefinitionId": "5f8d0d55b54764421b7156c3",
12     "slug": "employee-onboarding-template",
13     "name": "Employee Onboarding Template",
14     "description": "A DOCX template for onboarding new employees with dynamic fields.",
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-06-10T09:15:00Z",
33     "updatedAt": "2024-06-10T09:15:00Z",
34     "createdBy": "user_1234567890abcdef"
35   }
36 }

Creates a library template from a multipart upload (file + name + description + optional binding). The optional kind field selects the DOCX/Liquid path (synchronous engine lint) or the pdf-form blank-form path (AcroForm parse, no lint). Requires playbook:create.

Authentication

AuthorizationBearer

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

Request

The template file and its metadata.

filefileRequired

The template file (DOCX/Liquid or a blank PDF form).

namestringRequired

Template name.

descriptionstringOptional

Optional description.

kindenumOptional

Upload path; defaults to the DOCX/Liquid engine.

Allowed values:

bindingstringOptional

Optional JSON binding descriptor.

Response

The created template.

templateobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

422

Unprocessable Entity Error

503

Service Unavailable Error