Skip to main content
POST
/
relationships
/
delete
JavaScript SDK
await client.relationships.delete([{externalId: 'abc'}, {externalId: 'def'}]);
{}

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Body

application/json

Data required to delete relationships. You can delete a maximum of 1000 relationships per request.

items
object[]
required
Required array length: 1 - 1000 elements
ignoreUnknownIds
boolean
default:false

Ignore external IDs that are not found.

Response

Empty response for deleting relationships.

The response is of type object.

Last modified on April 23, 2026