solarOS Organization API

ssolarOS API
Go to app
Organization API

Delete an unstarted or cancelled calendar booking

Hard-deletes a calendar booking only before execution starts or after cancellation. Requires Idempotency-Key, emits audit/domain events, and removes the record from normal reads. The booking's draft report is soft-deleted when nothing has been entered in it; a draft with any work in it stays on the work order without a booking. Required scope: service_appointments:delete.

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

Hard-deletes a calendar booking only before execution starts or after cancellation. Requires Idempotency-Key, emits audit/domain events, and removes the record from normal reads. The booking's draft report is soft-deleted when nothing has been entered in it; a draft with any work in it stays on the work order without a booking. Required scope: service_appointments:delete.

Delete an unstarted or cancelled calendar booking. Use an organization API key with service_appointments:delete. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

service_appointments:deleteIdempotency-Key required

Parameters

NameInTypeDescription
idrequiredpathstringService Appointment identifier returned by the Organization API.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Delete action envelope

#/components/schemas/OrgApiActionEnvelope

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:delete

#/components/schemas/OrgApiError

409

Execution already started

#/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:delete409 Execution already started429 Rate limit exceeded

Static examples

curl -X DELETE "$SOLAROS_BASE_URL/api/v1/service-appointments/$SOLAROS_SERVICE_APPOINTMENT" \
  -H "Authorization: Bearer $SOLAROS_API_KEY" \
  -H "Idempotency-Key: $SOLAROS_IDEMPOTENCY_KEY"