BizKitHub
DocsAPI ReferenceBranch/bff/branch/delete
postBranchAdmin BFF

/bff/branch/delete

Sets the branch to inactive. The branch and all its related data (address, opening hours, images) are kept; only the active flag is flipped to false.

BranchpostBffBranchDelete

Parameters

JSON body

Request body

application/json
slugstringRequired

Branch slug to deactivate.

Response schema

1 status code documented

200Success
successbooleanRequired

Response example

application/json
{
  "success": false
}

Request example

POST /bff/branch/delete

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

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key