solarOSsolarOS Docs

Update editable Work Order metadata

Updates non-terminal Work Order metadata and customFields. Ownership is inherited from the containing Project and ownerId is rejected. Completion, cancellation, and scheduling remain explicit domain actions.

PATCH
/work-orders/{id}

Updates non-terminal Work Order metadata and customFields. Ownership is inherited from the containing Project and ownerId is rejected. Completion, cancellation, and scheduling remain explicit domain actions.

Authorization

Authorization<token>

Organization API key. Format: Bearer sk_live_...

In: header

Path Parameters

id*string

Work Order identifier returned by the Organization API.

Request Body

application/json

JSON request payload for updateWorkOrder.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/work-orders/string" \  -H "Content-Type: application/json" \  -d '{    "title": "Install PV array and inverter",    "priority": "HIGH"  }'
{  "data": {},  "meta": {    "requestId": "string",    "version": "v1",    "timestamp": "2019-08-24T14:15:22Z",    "rateLimit": {      "limit": 0,      "remaining": 0,      "reset": 0    }  }}