Update a template version
Platform module
PATCH/template-versions/{id}templateVersions.update
A version of a template (1032): the project defaults and ordered items. Edited while a draft; publishing (templateVersions.publish) freezes it and makes it the template's current version. 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 version. |
Request body: TemplateVersionUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| notes | string | null | No | What changed in this version.Constraints: length 1 to 20000 |
| default_time_zone | string | null | No | IANA time zone a new project starts with.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$ |
| default_tier_code | string | null | No | Canon tier a new project starts with.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| default_region_code | string | null | No | Canon region a new project starts with.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| default_jurisdiction_id | string | null | No | Canon jurisdiction a new project starts with.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| default_currency_code | string | null | No | ISO 4217 currency a new project starts with.Constraints: pattern ^[A-Z]{3}$ |
| duration_days | integer | null | No | Length of the project in days.Constraints: range 1 to any |
{
"notes": "Adds the load-out records.",
"default_time_zone": "America/New_York",
"default_tier_code": "05",
"default_region_code": "SE",
"default_jurisdiction_id": "US-FL-MIAMI-DADE",
"default_currency_code": "USD",
"duration_days": 3
}Response 200: TemplateVersion
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the template version. |
| 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. |
| 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. |
| template_id | string (uuid) | Yes | Identifier of the template. |
| version_number | integer | Yes | Version number, issued in order, 1 first.Constraints: range 1 to any |
| notes | string | null | Yes | What changed in this version.Constraints: length 1 to 20000 |
| default_time_zone | string | null | Yes | IANA time zone a new project starts with.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$ |
| default_tier_code | string | null | Yes | Canon tier a new project starts with.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| default_region_code | string | null | Yes | Canon region a new project starts with.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| default_jurisdiction_id | string | null | Yes | Canon jurisdiction a new project starts with.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| default_currency_code | string | null | Yes | ISO 4217 currency a new project starts with.Constraints: pattern ^[A-Z]{3}$ |
| duration_days | integer | null | Yes | Length of the project in days.Constraints: range 1 to any |
| published_at | string (date-time) | null | Yes | When the version was published; null while a draft. |
{
"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",
"template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"version_number": 1,
"notes": "Adds the load-out records.",
"default_time_zone": "America/New_York",
"default_tier_code": "05",
"default_region_code": "SE",
"default_jurisdiction_id": "US-FL-MIAMI-DADE",
"default_currency_code": "USD",
"duration_days": 3,
"published_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X PATCH "$XOS_BASE_URL/template-versions/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 '{"notes":"Adds the load-out records.","default_time_zone":"America/New_York","default_tier_code":"05","default_region_code":"SE","default_jurisdiction_id":"US-FL-MIAMI-DADE","default_currency_code":"USD","duration_days":3}'const { data, etag } = await xos.templateVersions.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"notes": "Adds the load-out records.",
"default_time_zone": "America/New_York",
"default_tier_code": "05",
"default_region_code": "SE",
"default_jurisdiction_id": "US-FL-MIAMI-DADE",
"default_currency_code": "USD",
"duration_days": 3
}, { ifMatch: etag });response = xos.template_versions.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"notes": "Adds the load-out records.", "default_time_zone": "America/New_York", "default_tier_code": "05", "default_region_code": "SE", "default_jurisdiction_id": "US-FL-MIAMI-DADE", "default_currency_code": "USD", "duration_days": 3}, if_match=etag)xos template-versions update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"notes":"Adds the load-out records.","default_time_zone":"America/New_York","default_tier_code":"05","default_region_code":"SE","default_jurisdiction_id":"US-FL-MIAMI-DADE","default_currency_code":"USD","duration_days":3}' --if-match auto