/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

JSON body

Request body

application/json

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.

Examplesmanagerownercustodian

customLabelstring | nullOptional

One of 2:

Variant 1

string

Free-text label (≤ 200 chars) shown next to / instead of the role. Optional.

Length: 0–200

Variant 2

null

positionnumberOptional

Sort position; lower = earlier. Default 0.

Response schema

1 status code documented

200Success

successbooleanRequired

idstringRequired

Response example

application/json

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

Request example

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
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key