Skip to content
XOS Developers

Update a form template

Workforce module

PATCH/form-templates/{id}formTemplates.update

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. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability knowledge.sop.write.
  • OAuth scopes: knowledge.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

formTemplates.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the form template.

Request body: FormTemplateUpdate

formTemplates.update: FormTemplateUpdate
FieldTypeRequiredDescription
namestringNoForm name, unique in the org.Constraints: length 1 to 200
descriptionstring | nullNoWhen to fill it in.Constraints: length 1 to 2000
record_kindstringNoCanon record kind each project submission becomes.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
record_subtypestring | nullNoCanon record subtype.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
fieldsarray of FormFieldNoField definitions in order.
requires_signaturebooleanNoWhether a submission must be signed.
requires_locationbooleanNoWhether a submission needs a GPS stamp.
pass_scorenumber | nullNoScore needed to pass; null when not scored to pass.Constraints: range 0 to any
approver_role_idstring (uuid) | nullNoIdentifier 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 200: FormTemplate

formTemplates.update: FormTemplate
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the form template.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesPerson who last updated the row; null for seed, platform or system writes.
namestringYesForm name, unique in the org.Constraints: length 1 to 200
descriptionstring | nullYesWhen to fill it in.Constraints: length 1 to 2000
record_kindstringYesCanon record kind each project submission becomes.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
record_subtypestring | nullYesCanon record subtype.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
fieldsarray of FormFieldYesField definitions in order.
requires_signaturebooleanYesWhether a submission must be signed.
requires_locationbooleanYesWhether a submission needs a GPS stamp.
pass_scorenumber | nullNoScore needed to pass; null when not scored to pass.Constraints: range 0 to any
approver_role_idstring (uuid) | nullYesIdentifier of the org role whose holders approve submissions.
template_state"Draft" | "Published" | "Retired"YesDraft, Published or Retired.
current_versionintegerYesLatest 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 PATCH "$XOS_BASE_URL/form-templates/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -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, etag } = await xos.formTemplates.update("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"
  }, { ifMatch: etag });
response = xos.form_templates.update("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"}, if_match=etag)
xos form-templates update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --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"}' --if-match auto