Saltar al contenido

Create a template version

Módulo Platform

POST/template-versionstemplateVersions.create

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. Creates a template version. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad projects.template.write.
  • Alcances de OAuth: projects.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: TemplateVersionCreate

templateVersions.create: TemplateVersionCreate
CampoTipoObligatorioDescripción
template_idstring (uuid)SíIdentifier of the template.
notesstring | nullNoWhat changed in this version.Restricciones: length 1 to 20000
default_time_zonestring | nullNoIANA time zone a new project starts with.Restricciones: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
default_tier_codestring | nullNoCanon tier a new project starts with.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_region_codestring | nullNoCanon region a new project starts with.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_jurisdiction_idstring | nullNoCanon jurisdiction a new project starts with.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_currency_codestring | nullNoISO 4217 currency a new project starts with.Restricciones: pattern ^[A-Z]{3}$
duration_daysinteger | nullNoLength of the project in days.Restricciones: range 1 to any
{
  "template_id": "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
}

Respuesta 201: TemplateVersion

templateVersions.create: TemplateVersion
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the template version.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row.
template_idstring (uuid)SíIdentifier of the template.
version_numberintegerSíVersion number, issued in order, 1 first.Restricciones: range 1 to any
notesstring | nullSíWhat changed in this version.Restricciones: length 1 to 20000
default_time_zonestring | nullSíIANA time zone a new project starts with.Restricciones: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
default_tier_codestring | nullSíCanon tier a new project starts with.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_region_codestring | nullSíCanon region a new project starts with.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_jurisdiction_idstring | nullSíCanon jurisdiction a new project starts with.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
default_currency_codestring | nullSíISO 4217 currency a new project starts with.Restricciones: pattern ^[A-Z]{3}$
duration_daysinteger | nullSíLength of the project in days.Restricciones: range 1 to any
published_atstring (date-time) | nullSí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"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/template-versions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"template_id":"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}'
const { data } = await xos.templateVersions.create({
    "template_id": "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
  });
response = xos.template_versions.create({"template_id": "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})
xos template-versions create --data '{"template_id":"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}'