Sign in

v1

latestOpenAPI 3.1.02026-07-22750642.5 KB
CDP Relationships

Register relationship type

Register a relationship type and its metadata. Re-registering an existing type updates it in place.

post/api/v1/cdp/relationship-types

Request body

kind'person_to_co' | 'co_to_co' required

Type kind. 'person_to_co' links people to one custom object type; 'co_to_co' links two custom object types.

rolestring required

Edge role, e.g. "placed" or "has_line_item".

customObjectTypestring

Custom object type name. Required when kind is 'person_to_co'.

parentCustomObjectTypestring

Parent custom object type name. Required when kind is 'co_to_co'.

childCustomObjectTypestring

Child custom object type name. Required when kind is 'co_to_co'.

cardinality'ONE_TO_ONE' | 'ONE_TO_MANY' | 'MANY_TO_ONE' | 'MANY_TO_MANY'

Optional cardinality: ONE_TO_ONE, ONE_TO_MANY, MANY_TO_ONE, MANY_TO_MANY.

descriptionstring

Optional human-readable description of the relationship type.

bidirectionalboolean

Optional: whether the relationship is bidirectional.

Response

Success

OR