solarOSsolarOS Docs

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.

DELETE
/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.

Authorization

Authorization<token>

Organization API key. Format: Bearer sk_live_...

In: header

Request Body

application/json

JSON request payload for deleteExternalReference.

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

curl -X DELETE "https://example.com/external-references" \  -H "Content-Type: application/json" \  -d '{    "externalSystem": "salesforce",    "externalObject": "WorkOrder",    "externalId": "0WO123",    "expectedResourceType": "WorkOrder",    "expectedResourceId": "work_order_123"  }'
{  "data": {    "action": {      "confirmed": true,      "confirmationSignal": "string"    },    "resource": {}  },  "meta": {    "requestId": "string",    "version": "v1",    "timestamp": "2019-08-24T14:15:22Z",    "rateLimit": {      "limit": 0,      "remaining": 0,      "reset": 0    }  }}