Skip to main content
DELETE
Unlink relationship

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Query Parameters

kind
enum<string>

Edge kind. 'person_to_co' (default) links a person to a custom object; 'co_to_co' links a parent custom object to a child custom object.

Available options:
person_to_co,
co_to_co
relationshipTypeId
string
required

Id of the relationship type (from the relationship-types list). Fixes the role and the custom object type(s) the edge targets.

Required string length: 1 - 255
personExternalId
string

Person externalId. Required when kind is 'person_to_co'.

Required string length: 1 - 255
customObjectExternalId
string

Custom object externalId. Required when kind is 'person_to_co'.

Required string length: 1 - 255
parentExternalId
string

Parent custom object externalId. Required when kind is 'co_to_co'.

Required string length: 1 - 255
childExternalId
string

Child custom object externalId. Required when kind is 'co_to_co'.

Required string length: 1 - 255

Response

Success

removed
boolean
required