BizKitHub
DocsAPI ReferenceOrganisation/bff/organisation/lifecycle/suspend
postOrganisationAdmin BFF

/bff/organisation/lifecycle/suspend

Sets cas__organisation.suspended_date = NOW(). The organisation is frozen: background jobs skip it, its API keys are rejected and no new blob can be written. Data is kept intact. Reversible via /lifecycle/resume. Writes a critical system log (ORG_SUSPEND) with a notification e-mail. Callable only by a human root member of the internal platform organisation.

OrganisationpostBffOrganisationLifecycleSuspend

Parameters

JSON body

Request body

application/json
organisationIdnumberRequired

Target organisation id to suspend. Must not be the internal org.

reasonstringOptional

Free-form reason kept in the system log + activity.

Length: 0–1000

Response schema

1 status code documented

200Success
successbooleanRequired
organisationIdnumberRequired
namestringRequired
suspendedDatestringRequired
alreadySuspendedbooleanRequired

Response example

application/json
{
  "success": false,
  "organisationId": 0,
  "name": "example_name",
  "suspendedDate": "example_suspendedDate",
  "alreadySuspended": false
}

Request example

POST /bff/organisation/lifecycle/suspend

post
curl -X POST "https://api.bizkithub.com/bff/organisation/lifecycle/suspend" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "organisationId": 0,
  "reason": "example_reason"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key