Update or archive/unarchive a form template
Edits name, project-required, the `fillableBy` audience, and/or blocks, and/or flips status (`{ "status": "archived" }` / `{ "status": "active" }`). Field edits apply first, then the status change.
Edits name, project-required, the fillableBy audience, and/or blocks,
and/or flips status ({ "status": "archived" } / { "status": "active" }).
Field edits apply first, then the status change.
The per-tenant API key, copied from Settings → API & integrations.
Sent as the x-api-key request header. The key is tenant-scoped and acts
with Admin-equivalent, tenant-wide access.
In: header
Path Parameters
Resource id.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
All fields optional. status archives/unarchives; the other fields edit
the template. Both may be sent together.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/form-templates/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "projectRequired": true, "fillableBy": "all_crew", "status": "active", "blocks": [ { "id": "string", "kind": "heading", "label": "string", "required": true, "options": [ "string" ], "items": [ "string" ], "lockToToday": true } ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}{ "error": { "code": "unauthorized", "message": "Missing or invalid API key." }}{ "error": { "code": "read_only", "message": "Your subscription is inactive. This action is read-only." }}{ "error": { "code": "not_found", "message": "Not found." }}{ "error": { "code": "validation", "message": "One or more inputs are invalid.", "fields": { "fieldName": "A message explaining what's wrong with this field." } }}