Party Relationship

This API endpoint allows you to establish a relationship between two parties. The request body should specify the party ID and the desired relationship type.

POST /omni-omni/v1/parties/{email}/relationships

🌱 Create a new relationship between two parties

cURL

curl --request POST \
  --url https://backend.sandbox.ecrop.de/ecrop-command/omni-omni/v1/parties/{email}/relationships \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partyEmail": "<string>"
}
'

201

{
  "partyEmail": "<string>",
  "id": 123
}

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

201

application/json

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