Update a form template

Módulo Workforce

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.

Requiere la capacidad knowledge.sop.write.
Alcances de OAuth: knowledge.
Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

formTemplates.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the form template.

Cuerpo de la solicitud: FormTemplateUpdate

formTemplates.update: FormTemplateUpdate
Campo	Tipo	Obligatorio	Descripción
name	string	No	Form name, unique in the org.Restricciones: length 1 to 200
description	string \| null	No	When to fill it in.Restricciones: length 1 to 2000
record_kind	string	No	Canon record kind each project submission becomes.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
record_subtype	string \| null	No	Canon record subtype.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
fields	array of FormField	No	Field definitions in order.
requires_signature	boolean	No	Whether a submission must be signed.
requires_location	boolean	No	Whether a submission needs a GPS stamp.
pass_score	number \| null	No	Score needed to pass; null when not scored to pass.Restricciones: 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"
}

Respuesta 200: FormTemplate

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

Ejemplos de código

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