Skip to content
HeyX API

Create Work Order

Required scope: work_order:create

locationDataFieldId must identify a populated location field on the target portfolio. Use ListDataFields to discover location field IDs. Template, workflow, advanced-task, and order-relinking controls are intentionally omitted.

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

Creates a manual portfolio work order. This operation is not idempotent.

Request CreateWorkOrderRequest
Response CreateWorkOrderResponse

CreateWorkOrderRequest

Field Type Description
portfolio_id string
location_data_field_id string ID of a populated portfolio location DataField.
title string
description string
tasks repeated CreateWorkOrderTaskInput

CreateWorkOrderResponse

Field Type
work_order WorkOrder

Related Types

CreateWorkOrderTaskInput

Field Type
body string

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 
{
  "portfolioId": "<portfolio-id>",
  "locationDataFieldId": "<location-data-field-id>",
  "title": "Install battery",
  "description": "Customer confirmed access",
  "tasks": [{ "body": "Mount enclosure" }]
}

This operation is not idempotent. Do not blindly retry after a timeout.

HeyX API