/bff/branch/create

Creates a new branch for the authenticated organisation. Generates a unique slug and validates internal code uniqueness. The branch_contact link and the list of associated people are set afterwards via the dedicated endpoints (/set-branch-contact, /add-branch-person).

BranchpostBffBranchCreate

Parameters

JSON body

Request body

application/json

namestringRequired

Branch display name.

Length: 1–∞

ExamplePrague Central

slugstringOptional

Preferred URL slug. Generated from name if empty.

internalCodestringOptional

Organisation-internal code (unique per organisation).

descriptionstringOptional

Short branch description.

urlstringOptional

Public branch URL.

Response schema

1 status code documented

200Success

successbooleanRequired

slugstringRequired

Final slug of the created branch.

Response example

application/json

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

Request example

POST /bff/branch/create

post

curl -X POST "https://api.bizkithub.com/bff/branch/create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "name": "Prague Central",
  "slug": "example_slug",
  "internalCode": "example_internalCode",
  "description": "example_description",
  "url": "example_url"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key