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. notes is rejected: Work Order Notes was retired on 2026-10-27; send job instructions in description.
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. notes is rejected: Work Order Notes was retired on 2026-10-27; send job instructions in description.
Update editable Work Order metadata. Use an organization API key with work_orders:write. Check the response envelope and meta.requestId before triggering dependent workflow steps.
Required scopes
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | string | Work Order identifier returned by the Organization API. |
Request body
| Field | Type | Description |
|---|---|---|
| title | string | Optional unless marked required. |
| description | string | null | Optional unless marked required. |
| status | NOT_READY_TO_SCHEDULE | READY_TO_SCHEDULE | SCHEDULED | IN_PROGRESS | Optional unless marked required. |
| priority | LOW | MEDIUM | HIGH | URGENT | Optional unless marked required. |
| estimatedHours | string | number | null | Optional unless marked required. |
| customFields | object | Field Values keyed by savedIdentity from GET /api/v1/schema. |
{
"title": "Install PV array and inverter",
"priority": "HIGH"
}Responses
Updated Work Order envelope
#/components/schemas/OrgApiResourceEnvelope
Validation error
#/components/schemas/OrgApiError
Missing or invalid organization API key
#/components/schemas/OrgApiError
Organization billing access or an endpoint-specific business quota denied the request
#/components/schemas/OrgApiError
Missing required scope: work_orders:write
#/components/schemas/OrgApiError
Not found
#/components/schemas/OrgApiError
Rate limit exceeded
#/components/schemas/OrgApiError
Errors
Static examples
curl -X PATCH "$SOLAROS_BASE_URL/api/v1/work-orders/$SOLAROS_WORK_ORDER" \
-H "Authorization: Bearer $SOLAROS_API_KEY" \
-H "Content-Type: application/json" \
--data '{"title":"Install PV array and inverter","priority":"HIGH"}'