Skip to main content
POST
🌱 Create a new relationship between two parties

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

email
string
required

Body

application/json
partyEmail
string
required
relationshipDirection
enum<string>
required
Available options:
MEMBER,
PARENT
relationshipType
enum<string>
required
Available options:
EXECUTIVE,
SUPERVISORY,
GENERAL_MEETING,
EMPLOYEE,
SHARE_HOLDER,
CONTROLLING_PERSON,
DIRECTOR,
CEO,
BOARD_CHAIRMAN,
BOARD_MEMBER,
SPOUSE,
HERITAGE

Response

Party relationship is created

partyEmail
string
required
relationshipDirection
enum<string>
required
Available options:
MEMBER,
PARENT
relationshipType
enum<string>
required
Available options:
EXECUTIVE,
SUPERVISORY,
GENERAL_MEETING,
EMPLOYEE,
SHARE_HOLDER,
CONTROLLING_PERSON,
DIRECTOR,
CEO,
BOARD_CHAIRMAN,
BOARD_MEMBER,
SPOUSE,
HERITAGE
id
integer<int64>
read-only