solarOS Organization API

Organization API

Delete an External Reference

Deletes one tenant-scoped External Reference tuple. The operation is idempotent when the tuple is already absent. Supply expectedResourceType and expectedResourceId to guard against deleting a tuple that was repointed by another worker. Unlike most DELETE endpoints, this operation requires a JSON request body. Required scope: external_references:write.

/api/v1/external-references

Deletes one tenant-scoped External Reference tuple. The operation is idempotent when the tuple is already absent. Supply expectedResourceType and expectedResourceId to guard against deleting a tuple that was repointed by another worker. Unlike most DELETE endpoints, this operation requires a JSON request body. Required scope: external_references:write.

Delete an External Reference. Use an organization API key with external_references:write. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

external_references:write

Parameters

No path or query parameters.

Request body

objectrequired
FieldTypeDescription
externalSystemrequiredstringOptional unless marked required.
externalObjectrequiredstringOptional unless marked required.
externalIdrequiredstringOptional unless marked required.
expectedResourceTypestringOptional unless marked required.
expectedResourceIdstringOptional unless marked required.
deleteexternalreferenceRequest
{
  "externalSystem": "salesforce",
  "externalObject": "WorkOrder",
  "externalId": "0WO123",
  "expectedResourceType": "WorkOrder",
  "expectedResourceId": "work_order_123"
}

Responses

200

Delete result envelope with deleted and id fields

#/components/schemas/OrgApiActionEnvelope

400

Invalid External Reference delete payload

#/components/schemas/OrgApiError

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 external_references:write scope

#/components/schemas/OrgApiError

409

Expected current target did not match

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

400 Invalid External Reference delete payload401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing external_references:write scope409 Expected current target did not match429 Rate limit exceeded

Static examples

curl -X DELETE "$SOLAROS_BASE_URL/api/v1/external-references" \
  -H "Authorization: Bearer $SOLAROS_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"externalSystem":"salesforce","externalObject":"WorkOrder","externalId":"0WO123","expectedResourceType":"WorkOrder","expectedResourceId":"work_order_123"}'