Update Work Order Template

Required scope: work_order_template:update

This bounded update changes only a template’s work-order title, description, and preferred location field. Supply at least one of those fields; omitted fields keep their current values. The template’s manual tasks and advanced tasks are preserved unchanged. Editing a template requires settings write access.

Generated Reference

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

Updates a template's descriptive fields only. Requires settings write access. Task lists cannot be edited through the public API.

Request UpdateWorkOrderTemplateRequest

Response UpdateWorkOrderTemplateResponse

UpdateWorkOrderTemplateRequest

Field	Type	Description
`id`	`string`	Identifies the template to update.
`title`	`optional string`	New work-order title. Omit to leave unchanged.
`description`	`optional string`	New description. Omit to leave unchanged.
`preferred_location_data_field_id`	`optional string`	Active location field from ListWorkOrderTemplateLocationFields. Omit to leave unchanged; existing manual and advanced tasks are always preserved.

UpdateWorkOrderTemplateResponse

Field	Type	Description
`work_order_template`	`WorkOrderTemplate`	The work order template after the update.

Related Types

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`

Request

{
  "id": "<work-order-template-id>",
  "title": "Annual maintenance",
  "description": "Standard yearly service checklist.",
  "preferredLocationDataFieldId": "<location-field-id>"
}

The response contains the updated workOrderTemplate. Do not blindly retry a timed-out mutation; it may still complete.