/bff/branch/holding/link

Creates a typed relationship between two company contacts. Duplicates per (org, parent, child, relationType) are rejected by a unique index. Self-loops are forbidden at the DB level.

BranchpostBffBranchHoldingLink

Parameters

7 body

7 total

Body · 7

parentContactRefstringRequired

CuRefNo of the parent (owning) company contact.

childContactRefstringRequired

CuRefNo of the child (owned) company contact.

relationTypestring | string | string | string | stringRequired

Kind of relationship.

ownershipPercentnumber | null

validFromstring | null

validTostring | null

notesstring | null

Request

POST /bff/branch/holding/link

post

curl -X POST "https://api.bizkithub.com/bff/branch/holding/link" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "parentContactRef": "example_parentContactRef",
  "childContactRef": "example_childContactRef"
}'

Response

JSON payload

{
  "success": false,
  "id": "example_id"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key