solarOSsolarOS Docs

Update schedule, assignment, notes, confidence, or window

Updates rescheduling fields, assignment changes, notes, scheduling confidence, and customer-facing windows. Direct operational status writes are rejected; use action endpoints instead. Scheduling confidence wire values are TENTATIVELY_SCHEDULED, CONFIDENTLY_SCHEDULED, and CONFIRMED.

PATCH
/service-appointments/{id}

Updates rescheduling fields, assignment changes, notes, scheduling confidence, and customer-facing windows. Direct operational status writes are rejected; use action endpoints instead. Scheduling confidence wire values are TENTATIVELY_SCHEDULED, CONFIDENTLY_SCHEDULED, and CONFIRMED.

Authorization

Authorization<token>

Organization API key. Format: Bearer sk_live_...

In: header

Path Parameters

id*string

Service Appointment identifier returned by the Organization API.

Request Body

application/json

JSON request payload for updateServiceAppointment.

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

application/json

curl -X PATCH "https://example.com/service-appointments/string" \  -H "Content-Type: application/json" \  -d '{    "scheduledStart": "2026-08-13T17:00:00Z",    "scheduledEnd": "2026-08-13T21:00:00Z",    "timezone": "America/Los_Angeles",    "notes": "Customer gate code is in the Work Order notes."  }'
{  "data": {},  "meta": {    "requestId": "string",    "version": "v1",    "timestamp": "2019-08-24T14:15:22Z",    "rateLimit": {      "limit": 0,      "remaining": 0,      "reset": 0    }  }}