Create a form template

Workforce module

POST/form-templatesformTemplates.create

A no-code form with conditional fields, photos, GPS stamp, signature, scoring and approval routing. Project submissions become records of its canon kind and subtype. Creates a form template. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability knowledge.sop.write.
OAuth scopes: knowledge.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: FormTemplateCreate

formTemplates.create: FormTemplateCreate
Field	Type	Required	Description
name	string	Yes	Form name, unique in the org.Constraints: length 1 to 200
description	string \| null	No	When to fill it in.Constraints: length 1 to 2000
record_kind	string	Yes	Canon record kind each project submission becomes.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
record_subtype	string \| null	No	Canon record subtype.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
fields	array of FormField	Yes	Field definitions in order.
requires_signature	boolean	Yes	Whether a submission must be signed.
requires_location	boolean	Yes	Whether a submission needs a GPS stamp.
pass_score	number \| null	No	Score needed to pass; null when not scored to pass.Constraints: range 0 to any
approver_role_id	string (uuid) \| null	No	Identifier of the org role whose holders approve submissions.

{
  "name": "Rigging pre-use check",
  "description": "Before every lift.",
  "record_kind": "Inspection",
  "record_subtype": "Safety",
  "fields": [
    {
      "key": "hoist_ok",
      "label": "Hoist inspected",
      "kind": "yes_no"
    }
  ],
  "requires_signature": true,
  "requires_location": true,
  "pass_score": 2,
  "approver_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 201: FormTemplate

formTemplates.create: FormTemplate
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the form template.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Person who last updated the row; null for seed, platform or system writes.
name	string	Yes	Form name, unique in the org.Constraints: length 1 to 200
description	string \| null	Yes	When to fill it in.Constraints: length 1 to 2000
record_kind	string	Yes	Canon record kind each project submission becomes.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
record_subtype	string \| null	Yes	Canon record subtype.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
fields	array of FormField	Yes	Field definitions in order.
requires_signature	boolean	Yes	Whether a submission must be signed.
requires_location	boolean	Yes	Whether a submission needs a GPS stamp.
pass_score	number \| null	No	Score needed to pass; null when not scored to pass.Constraints: range 0 to any
approver_role_id	string (uuid) \| null	Yes	Identifier of the org role whose holders approve submissions.
template_state	"Draft" \| "Published" \| "Retired"	Yes	Draft, Published or Retired.
current_version	integer	Yes	Latest published version; 0 before the first publish.Constraints: range 0 to any

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Rigging pre-use check",
  "description": "Before every lift.",
  "record_kind": "Inspection",
  "record_subtype": "Safety",
  "fields": [
    {
      "key": "hoist_ok",
      "label": "Hoist inspected",
      "kind": "yes_no"
    }
  ],
  "requires_signature": true,
  "requires_location": true,
  "pass_score": 2,
  "approver_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "template_state": "Draft",
  "current_version": 1
}

Code samples

curl -X POST "$XOS_BASE_URL/form-templates" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Rigging pre-use check","description":"Before every lift.","record_kind":"Inspection","record_subtype":"Safety","fields":[{"key":"hoist_ok","label":"Hoist inspected","kind":"yes_no"}],"requires_signature":true,"requires_location":true,"pass_score":2,"approver_role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data } = await xos.formTemplates.create({
    "name": "Rigging pre-use check",
    "description": "Before every lift.",
    "record_kind": "Inspection",
    "record_subtype": "Safety",
    "fields": [
      {
        "key": "hoist_ok",
        "label": "Hoist inspected",
        "kind": "yes_no"
      }
    ],
    "requires_signature": true,
    "requires_location": true,
    "pass_score": 2,
    "approver_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });

response = xos.form_templates.create({"name": "Rigging pre-use check", "description": "Before every lift.", "record_kind": "Inspection", "record_subtype": "Safety", "fields": [{"key": "hoist_ok", "label": "Hoist inspected", "kind": "yes_no"}], "requires_signature": True, "requires_location": True, "pass_score": 2, "approver_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})

xos form-templates create --data '{"name":"Rigging pre-use check","description":"Before every lift.","record_kind":"Inspection","record_subtype":"Safety","fields":[{"key":"hoist_ok","label":"Hoist inspected","kind":"yes_no"}],"requires_signature":true,"requires_location":true,"pass_score":2,"approver_role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'