Repair an External Reference target
Repoints one existing tenant-scoped External Reference only when expectedCurrentResourceType and expectedCurrentResourceId exactly match the current target. Missing tuples return 404; stale guards return 409. Required scope: external_references:write.
Repoints one existing tenant-scoped External Reference only when expectedCurrentResourceType and expectedCurrentResourceId exactly match the current target. Missing tuples return 404; stale guards return 409. Required scope: external_references:write.
Repair an External Reference target. 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 |
|---|---|---|
| resourceTyperequired | string | Optional unless marked required. |
| resourceIdrequired | string | Optional unless marked required. |
| expectedCurrentResourceTyperequired | string | Optional unless marked required. |
| expectedCurrentResourceIdrequired | string | Optional unless marked required. |
| externalSystemrequired | string | Optional unless marked required. |
| externalObjectrequired | string | Optional unless marked required. |
| externalIdrequired | string | Optional unless marked required. |
| metadata | object | Optional unless marked required. |
{
"resourceType": "WorkOrder",
"resourceId": "work_order_456",
"expectedCurrentResourceType": "WorkOrder",
"expectedCurrentResourceId": "work_order_123",
"externalSystem": "salesforce",
"externalObject": "WorkOrder",
"externalId": "0WO123"
}Responses
External Reference repaired envelope
#/components/schemas/OrgApiResourceEnvelope
Invalid External Reference repair 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
External Reference not found
#/components/schemas/OrgApiError
Expected current target did not match
#/components/schemas/OrgApiError
Rate limit exceeded
#/components/schemas/OrgApiError
Errors
Static examples
curl -X PATCH "$SOLAROS_BASE_URL/api/v1/external-references" \
-H "Authorization: Bearer $SOLAROS_API_KEY" \
-H "Content-Type: application/json" \
--data '{"resourceType":"WorkOrder","resourceId":"work_order_456","expectedCurrentResourceType":"WorkOrder","expectedCurrentResourceId":"work_order_123","externalSystem":"salesforce","externalObject":"WorkOrder","externalId":"0WO123"}'