Update a template
Platform module
PATCH/templates/{id}templates.update
A project or record template, including the XOS 4.0 Production Template copy. 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 projects.template.write.
- OAuth scopes: projects.
- 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
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the template. |
Request body: TemplateUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | No | Template name.Constraints: length 1 to 300 |
| description | string | null | No | When to use the template.Constraints: length 1 to 20000 |
| template_kind | "Project" | No | What the template creates. |
{
"name": "Three-Day Festival",
"description": "Outdoor weekend shows.",
"template_kind": "Project"
}Response 200: Template
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the 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 | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Yes | Template name.Constraints: length 1 to 300 |
| current_version_id | string (uuid) | null | Yes | Identifier of the current version. |
| description | string | null | Yes | When to use the template.Constraints: length 1 to 20000 |
| template_kind | "Project" | Yes | What the template creates. |
{
"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": "Three-Day Festival",
"current_version_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "Outdoor weekend shows.",
"template_kind": "Project"
}Code samples
curl -X PATCH "$XOS_BASE_URL/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":"Three-Day Festival","description":"Outdoor weekend shows.","template_kind":"Project"}'const { data, etag } = await xos.templates.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"name": "Three-Day Festival",
"description": "Outdoor weekend shows.",
"template_kind": "Project"
}, { ifMatch: etag });response = xos.templates.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Three-Day Festival", "description": "Outdoor weekend shows.", "template_kind": "Project"}, if_match=etag)xos templates update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Three-Day Festival","description":"Outdoor weekend shows.","template_kind":"Project"}' --if-match auto