DocsAPI ReferenceBranch/bff/branch/attach-lock
postBranchAdmin BFF

/bff/branch/attach-lock

Sets iot__ttlock_lock.branch_id to the branch identified by slug. Overwrites any previous branch assignment on the lock — locks have at-most-one branch. The branch then becomes the operational technical contact for the lock.

BranchpostBffBranchAttach-lock

Parameters

2 body

2 total
Body · 2
slugstringRequired

Branch slug to attach the lock to.

lockIdnumberRequired

External TTLock identifier (matches the lock detail URL).

Request

POST /bff/branch/attach-lock

post
curl -X POST "https://api.bizkithub.com/bff/branch/attach-lock" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "slug": "example_slug",
  "lockId": 0
}'

Response

JSON payload

{
  "success": false,
  "lockId": 0,
  "branchId": 0,
  "branchSlug": "example_branchSlug"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key