/bff/branch/closure-create

Creates a closure row for the branch. End date is optional — leave it out for a closure that lasts "until further notice". The reason is required so the audit feed (and a future Finance report drill-down) always has a human-readable explanation.

BranchpostBffBranchClosure-create

Parameters

JSON body

Request body

application/json

branchSlugstringRequired

Branch slug the closure applies to.

startDatestringRequired

ISO timestamp the closure begins.

Length: 1–∞

endDatestring | nullOptional

One of 2:

Variant 1

string

ISO timestamp the closure ends. Null / omitted = open-ended ("until further notice"). Must be strictly after startDate.

Variant 2

null

reasonstringRequired

Operator-supplied reason. Required.

Length: 1–∞

Response schema

1 status code documented

200Success

successbooleanRequired

closureIdstringRequired

Response example

application/json

{
  "success": false,
  "closureId": "example_closureId"
}

Request example

POST /bff/branch/closure-create

post

curl -X POST "https://api.bizkithub.com/bff/branch/closure-create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "branchSlug": "example_branchSlug",
  "startDate": "example_startDate",
  "reason": "example_reason"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key