/bff/branch/update

Updates editable fields of a branch. Only provided fields are changed; undefined fields are preserved. Null values explicitly clear nullable fields.

BranchpostBffBranchUpdate

Parameters

20 body

20 total

Body · 20

slugstringRequired

Branch slug (used to identify the branch).

namestring

New branch display name.

Length: 1–∞

descriptionstring | null

internalCodestring | null

urlstring | null

activeboolean

Whether the branch is active.

latitudenumber | null

longitudenumber | null

branchContactIdstring | null

establishedDatestring | null

openedDatestring

Date the branch started serving customers (ISO timestamp). Drives the financial roll-up bucket key. Cannot be null — every branch must have an opened date.

Length: 1–∞

termsAndConditionsstring | null

complaintsProcedurestring | null

privacyPolicystring | null

internalDescriptionstring | null

staffInstructionsstring | null

aiInstructionsstring | null

branchTypestring | string | string

Branch kind. Cannot be null — defaults to "own" if never set.

parentBranchSlugstring | null

operatingCompanyContactRefstring | null

Request

POST /bff/branch/update

post

curl -X POST "https://api.bizkithub.com/bff/branch/update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "slug": "prague-central",
  "name": "example_name",
  "active": false,
  "openedDate": "example_openedDate"
}'

Response

JSON payload

{
  "success": false,
  "slug": "example_slug"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key