Register relationship type
Register a relationship type and its metadata. Re-registering an existing type updates it in place.
Authorizations
Organization API key, sent as Authorization: Bearer boom_org_....
Body
Type kind. 'person_to_co' links people to one custom object type; 'co_to_co' links two custom object types.
person_to_co, co_to_co Edge role, e.g. "placed" or "has_line_item".
1 - 255Custom object type name. Required when kind is 'person_to_co'.
1 - 255Parent custom object type name. Required when kind is 'co_to_co'.
1 - 255Child custom object type name. Required when kind is 'co_to_co'.
1 - 255Optional cardinality: ONE_TO_ONE, ONE_TO_MANY, MANY_TO_ONE, MANY_TO_MANY.
ONE_TO_ONE, ONE_TO_MANY, MANY_TO_ONE, MANY_TO_MANY Optional human-readable description of the relationship type.
1 - 1000Optional: whether the relationship is bidirectional.
Response
Success
- Option 1
- Option 2
"person_to_co"Edge role, e.g. "placed" or "has_line_item".
ONE_TO_ONE, ONE_TO_MANY, MANY_TO_ONE, MANY_TO_MANY