DocsAPI ReferenceBranch/bff/branch/holding/unlink
postBranchAdmin BFF

/bff/branch/holding/unlink

Hard-deletes the holding-link row. Always scoped by organisation. Idempotent — deleting a missing row returns { deleted: false } rather than throwing.

BranchpostBffBranchHoldingUnlink

Parameters

1 body

1 total
Body · 1
linkIdstringRequired

Internal id of the holding-link row (from /holding-tree).

Request

POST /bff/branch/holding/unlink

post
curl -X POST "https://api.bizkithub.com/bff/branch/holding/unlink" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "linkId": "example_linkId"
}'

Response

JSON payload

{
  "success": false,
  "deleted": false
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key