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.
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
Parameters
No path or query parameters.
Request body
| Field | Type | Description |
|---|---|---|
| externalSystemrequired | string | Optional unless marked required. |
| externalObjectrequired | string | Optional unless marked required. |
| externalIdrequired | string | Optional unless marked required. |
| expectedResourceType | string | Optional unless marked required. |
| expectedResourceId | string | Optional unless marked required. |
{
"externalSystem": "salesforce",
"externalObject": "WorkOrder",
"externalId": "0WO123",
"expectedResourceType": "WorkOrder",
"expectedResourceId": "work_order_123"
}Responses
Delete result envelope with deleted and id fields
#/components/schemas/OrgApiActionEnvelope
Invalid External Reference delete payload
#/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 external_references:write scope
#/components/schemas/OrgApiError
Expected current target did not match
#/components/schemas/OrgApiError
Rate limit exceeded
#/components/schemas/OrgApiError
Errors
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"}'