solarOS Organization API

Organization API

Create a Service Appointment issue

Creates a typed unresolved issue. The writable fields are issueType, notes, and reportedByTeamMemberId; severity, title, and description are not accepted.

/api/v1/service-appointments/{id}/issues

Creates a typed unresolved issue. The writable fields are issueType, notes, and reportedByTeamMemberId; severity, title, and description are not accepted.

Create a Service Appointment issue. Use an organization API key with service_appointments:issues:write. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

service_appointments:issues:writeIdempotency-Key required

Parameters

NameInTypeDescription
idrequiredpathstringService Appointment identifier returned by the Organization API.

Request body

objectrequired
FieldTypeDescription
issueTyperequiredHOMEOWNER_NOT_HOME | ACCESS_ISSUE | UNSAFE_CONDITIONS | MISSING_EQUIPMENT | CUSTOMER_REFUSED | OTHEROptional unless marked required.
notesstring | nullOptional unless marked required.
reportedByTeamMemberIdstringOptional unless marked required.
createserviceappointmentissueRequest
{
  "issueType": "ACCESS_ISSUE",
  "notes": "Property manager approval is required for roof access."
}

Responses

201

Created issue envelope

#/components/schemas/OrgApiResourceEnvelope

401

Missing or invalid organization API key

#/components/schemas/OrgApiError

402

Organization billing access or an endpoint-specific business quota denied the request

#/components/schemas/OrgApiError

403

Missing required scope: service_appointments:issues:write

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing required scope: service_appointments:issues:write429 Rate limit exceeded

Static examples

curl -X POST "$SOLAROS_BASE_URL/api/v1/service-appointments/$SOLAROS_SERVICE_APPOINTMENT/issues" \
  -H "Authorization: Bearer $SOLAROS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $SOLAROS_IDEMPOTENCY_KEY" \
  --data '{"issueType":"ACCESS_ISSUE","notes":"Property manager approval is required for roof access."}'