Skip to content
HeyX API

Update Work Order

Required scope: work_order:update

This bounded update changes only the title and description. It does not complete, cancel, or otherwise transition the work order. The API key creator must have current access to its portfolio.

Generated Reference
POST /public-api/publicapi.v1.WorkOrder/UpdateWorkOrder

Updates a work order while preserving portfolio access rules.

Request UpdateWorkOrderRequest
Response UpdateWorkOrderResponse

UpdateWorkOrderRequest

Field Type
id string
title optional string
description optional string

UpdateWorkOrderResponse

Field Type
work_order WorkOrder

Related Types

WorkOrder

Field Type
id string
portfolio_id string
title string
description string
status string
created_at int64
updated_at int64
portfolio_reference_number string
portfolio_title string
total_tasks int32
completed_tasks int32
work_order_template_id optional string

Request

Section titled “Request”
{
  "id": "<work-order-id>",
  "title": "Install replacement inverter",
  "description": "Schedule after parts delivery."
}

Do not blindly retry a timed-out mutation; it may still complete.

HeyX API