Skip to content
HeyX API

Create Work Order Template

POST /public-api/publicapi.v1.WorkOrderTemplate/CreateWorkOrderTemplate

Required scope: work_order_template:create. Requires settings write access. Template discovery permission alone does not permit authoring.

{
  "title": "Install battery",
  "description": "Installation checklist",
  "preferredLocationDataFieldId": "<location-data-field-id>",
  "tasks": [{ "body": "Mount enclosure" }]
}

title is required, nonblank, and limited to 200 characters. Description is limited to 2,000. preferredLocationDataFieldId must be an active workspace location field from List Location Fields, not an inventory location. Up to 100 manual tasks are accepted with nonblank bodies limited to 2,000 characters each, ordered as supplied.

Returns workOrderTemplate; its preferredLocation contains the selected field ID, not necessarily its name and label. This creates a template, not a work order. No customer values, advanced-task configuration, arbitrary JSON, or workflow/editor configuration can be supplied.

This operation is not idempotent. Do not blindly retry after a timeout. An active template with the same title returns HTTP 409 with a safe conflict message, not database details; it does not create another template.

Generated Reference
POST /public-api/publicapi.v1.WorkOrderTemplate/CreateWorkOrderTemplate

Creates a template with manual tasks only. Not idempotent.

Request CreateWorkOrderTemplateRequest
Response CreateWorkOrderTemplateResponse

CreateWorkOrderTemplateRequest

Field Type Description
title string
description string
preferred_location_data_field_id string Choose an active field from ListWorkOrderTemplateLocationFields.
tasks repeated CreateWorkOrderTemplateTaskInput

CreateWorkOrderTemplateResponse

Field Type
work_order_template WorkOrderTemplate

Related Types

CreateWorkOrderTemplateTaskInput

Field Type
body string

WorkOrderTemplate

Field Type Description
id string
title string
description string At most 2000 characters; list responses omit this field.
description_truncated bool
preferred_location WorkOrderLocationField
manual_task_count int32
advanced_task_count int32
requires_location_override bool True when no active preferred location is available. Creation then needs an explicit populated customer location override.

WorkOrderLocationField

Field Type
id string
name string
label string
HeyX API