Skip to content

Archive Work Order Template

Required scope: work_order_template:archive

Soft-archive a work-order template so it is no longer offered when creating new work orders. Existing work orders created from it are unaffected. Archiving requires full settings access.

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

Archives a template so it can no longer be selected, preserving its history. Requires settings full access. Effectively idempotent.

Request ArchiveWorkOrderTemplateRequest
Response ArchiveWorkOrderTemplateResponse

ArchiveWorkOrderTemplateRequest

Field Type Description
id string Identifies the template to archive.

ArchiveWorkOrderTemplateResponse

Field Type Description
success bool True when the template is archived.
{
"id": "<work-order-template-id>"
}
{
"success": true
}

This is not idempotent; do not blindly retry a timed-out call.