Skip to content

Save a project as a template

Platform module

POST/templates/from-projecttemplates.createFromProject

Creates a template from a project as the caller (app.create_template_from_project): its defaults, show and standing venue scope nodes and open records become a published first version. Needs projects.template.write. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability projects.template.write.
  • 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: TemplateFromProjectRequest

templates.createFromProject: TemplateFromProjectRequest
FieldTypeRequiredDescription
project_idstring (uuid)YesIdentifier of the project saved as a template.
namestringYesTemplate name.Constraints: length 1 to 200
descriptionstringNoWhen to use the template.Constraints: length 1 to 20000
{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Three-Day Festival",
  "description": "Outdoor weekend shows."
}

Response 201: Template

templates.createFromProject: Template
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the template.
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.
namestringYesTemplate name.Constraints: length 1 to 300
current_version_idstring (uuid) | nullYesIdentifier of the current version.
descriptionstring | nullYesWhen to use the template.Constraints: length 1 to 20000
template_kind"Project"YesWhat 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 POST "$XOS_BASE_URL/templates/from-project" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","name":"Three-Day Festival","description":"Outdoor weekend shows."}'
const { data } = await xos.templates.createFromProject({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "name": "Three-Day Festival",
    "description": "Outdoor weekend shows."
  });
response = xos.templates.create_from_project({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "name": "Three-Day Festival", "description": "Outdoor weekend shows."})
xos templates create-from-project --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","name":"Three-Day Festival","description":"Outdoor weekend shows."}'