solarOS Organization API

ssolarOS API
Go to app
Organization API

Create or update an External Record Link on a Case

Creates a navigable context link on the Case, or updates labels and data when the same URL is already linked. Requires Idempotency-Key and cases:write.

/api/v1/cases/{id}/external-record-links

Creates a navigable context link on the Case, or updates labels and data when the same URL is already linked. Requires Idempotency-Key and cases:write.

Create or update an External Record Link on a Case. Use an organization API key with cases:write. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

cases:writeIdempotency-Key required

Parameters

NameInTypeDescription
idrequiredpathstringCase identifier returned by the Organization API.

Request body

objectrequired
FieldTypeDescription
externalSystemrequiredstringOptional unless marked required.
externalSystemLabelrequiredstringOptional unless marked required.
objectLabelrequiredstringOptional unless marked required.
recordLabelrequiredstringOptional unless marked required.
urlrequiredstringOptional unless marked required.
externalIdstring | nullOptional unless marked required.
dataobjectOptional unless marked required.
createcaseexternalrecordlinkRequest
{
  "externalSystem": "salesforce",
  "externalSystemLabel": "Salesforce",
  "objectLabel": "Account",
  "recordLabel": "Paul Mundell",
  "url": "https://example.my.salesforce.com/lightning/r/Account/001.../view"
}

Responses

200

Updated External Record Link envelope

#/components/schemas/OrgApiResourceEnvelope

201

Created External Record Link envelope

#/components/schemas/OrgApiResourceEnvelope

400

Validation or idempotency error

#/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 required scope: cases:write

#/components/schemas/OrgApiError

404

Case not found

#/components/schemas/OrgApiError

409

Idempotency conflict

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

400 Validation or idempotency error401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing required scope: cases:write404 Case not found409 Idempotency conflict429 Rate limit exceeded

Static examples

curl -X POST "$SOLAROS_BASE_URL/api/v1/cases/$SOLAROS_CASE/external-record-links" \
  -H "Authorization: Bearer $SOLAROS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $SOLAROS_IDEMPOTENCY_KEY" \
  --data '{"externalSystem":"salesforce","externalSystemLabel":"Salesforce","objectLabel":"Account","recordLabel":"Paul Mundell","url":"https://example.my.salesforce.com/lightning/r/Account/001.../view"}'