/bff/branch/add-branch-person

Creates a new shop__branch_person row linking a contact to the branch in a given role. Idempotent on (branchId, contactId, role) — if the link already exists the customLabel and position are updated instead of failing with a constraint violation.

BranchpostBffBranchAdd-branch-person

Parameters

5 body

5 total

Body · 5

slugstringRequired

Branch slug.

contactIdstringRequired

CuRefNo of the contact to link to the branch.

rolestringRequired

Role enum. Allowed: branch_contact, owner, manager, custodian, cleaner, technician, accountant, security, support, other.

customLabelstring | null

positionnumber

Sort position; lower = earlier. Default 0.

Request

POST /bff/branch/add-branch-person

post

curl -X POST "https://api.bizkithub.com/bff/branch/add-branch-person" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "slug": "example_slug",
  "contactId": "example_contactId",
  "role": "manager",
  "position": 0
}'

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