Replace a form template file

POST

/templates/:id/form-file

POST

/templates/:id/form-file

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

1 {
2   "template": {
3     "_id": "642f1b2e9f1b2c0012345678",
4     "kind": "pdf-form",
5     "formModality": "pdf-acroform",
6     "formFields": [
7       {
8         "name": "fullName",
9         "type": "text",
10         "required": true,
11         "page": 1,
12         "fieldRect": [
13           100,
14           700,
15           300,
16           720
17         ]
18       }
19     ],
20     "detection": {
21       "detectedFields": 5,
22       "lastScan": "2024-06-10T12:00:00Z"
23     },
24     "scope": "library",
25     "actionDefinitionId": null,
26     "slug": "employee-onboarding-form",
27     "name": "Employee Onboarding PDF Form",
28     "description": "Blank PDF form template for new employee onboarding.",
29     "status": "active",
30     "version": 2,
31     "file": {
32       "filename": "onboarding_form_v2.pdf",
33       "size": 245760,
34       "contentType": "application/pdf",
35       "checksum": "3a7bd3e2360a3f1b2c4d5e6f7a8b9c0d"
36     },
37     "binding": {
38       "fullName": "employee.name",
39       "startDate": "employee.start_date"
40     },
41     "variables": [
42       {
43         "name": "employeeName",
44         "type": "string",
45         "default": ""
46       }
47     ],
48     "lint": {
49       "errors": [],
50       "warnings": []
51     },
52     "sampleData": {
53       "employeeName": "Jane Doe",
54       "startDate": "2024-07-01"
55     },
56     "archivedAt": null,
57     "createdAt": "2023-11-15T09:30:00Z",
58     "updatedAt": "2024-06-10T12:00:00Z",
59     "createdBy": "user_7890"
60   }
61 }

Replaces a pdf-form template’s blank form: re-parses the AcroForm to recompute fields/modality, resets cached detection, writes an immutable v{n+1} R2 object, and bumps the version (old version objects retained for pinned fill actions). No engine lint. A DOCX/Liquid row uses PUT /:id/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