Skip to content

Create a template application

Platform module

POST/template-applicationstemplateApplications.create

A template applied to create a project and its records. Creates a template application. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability projects.project.create.
  • OAuth scopes: projects.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: TemplateApplicationCreate

templateApplications.create: TemplateApplicationCreate
FieldTypeRequiredDescription
template_idstring (uuid)YesIdentifier of the template.
project_keystringYesKey of the project to create.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
namestringYesName of the project to create.Constraints: length 1 to 200
time_zonestringNoIANA time zone; defaults to the version's.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$
starts_onstring (date)NoStart date; records are due relative to it.
venue_idstring (uuid)NoIdentifier of the venue of the project and its shows.
{
  "template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_key": "NWT",
  "name": "Tidewater Weekend",
  "time_zone": "America/New_York",
  "starts_on": "2026-10-08",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 201: TemplateApplication

templateApplications.create: TemplateApplication
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the template application.
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) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
template_idstring (uuid)YesIdentifier of the template.
project_idstring (uuid)YesIdentifier of the created project.
template_version_idstring (uuid)YesIdentifier of the published version applied.
scope_nodes_createdintegerYesScope nodes created.Constraints: range 0 to any
records_createdintegerYesRecords created.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",
  "template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "template_version_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scope_nodes_created": 1,
  "records_created": 4
}

Code samples

curl -X POST "$XOS_BASE_URL/template-applications" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"template_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_key":"NWT","name":"Tidewater Weekend","time_zone":"America/New_York","starts_on":"2026-10-08","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.templateApplications.create({
    "template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "project_key": "NWT",
    "name": "Tidewater Weekend",
    "time_zone": "America/New_York",
    "starts_on": "2026-10-08",
    "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.template_applications.create({"template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "project_key": "NWT", "name": "Tidewater Weekend", "time_zone": "America/New_York", "starts_on": "2026-10-08", "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos template-applications create --data '{"template_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_key":"NWT","name":"Tidewater Weekend","time_zone":"America/New_York","starts_on":"2026-10-08","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'