DeveloperAPI ReferenceEntitiesIdCanonical ids
/api/entities/{id}/canonical-ids
Path Parameters
id*string
Resource ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/entities/string/canonical-ids" \ -H "Content-Type: application/json" \ -d '{ "provider": "string", "externalId": "string" }'{
"canonicalId": {
"id": "string",
"entityId": "string",
"provider": "string",
"externalId": "string",
"url": "string"
},
"refreshQueued": true
}{
"error": "string"
}{
"error": "string"
}{
"error": "string",
"ownedBy": {
"id": "string",
"name": "string"
}
}