USuseboom
CDP Relationships

Link relationship

Link a person to a custom object, or one custom object to another. Idempotent.

post/api/v1/cdp/relationships

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Request body

kind'person_to_co' | 'co_to_co'

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.

relationshipTypeIdstring required

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

personExternalIdstring

Person externalId. Required when kind is 'person_to_co'.

customObjectExternalIdstring

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

parentExternalIdstring

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

childExternalIdstring

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

Response

Success

createdboolean required
relationshipTypeIdstring required

Changes

No recorded changes to this operation across all 3 revisions of this API.