Parameters
JSON body
Request body
application/jsonorganisationIdnumberRequiredTarget organisation id to suspend. Must not be the internal org.
reasonstringOptionalFree-form reason kept in the system log + activity.
Length: 0–1000
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.
JSON body
organisationIdnumberRequiredTarget organisation id to suspend. Must not be the internal org.
reasonstringOptionalFree-form reason kept in the system log + activity.
1 status code documented
successbooleanRequiredorganisationIdnumberRequirednamestringRequiredsuspendedDatestringRequiredalreadySuspendedbooleanRequired{
"success": false,
"organisationId": 0,
"name": "example_name",
"suspendedDate": "example_suspendedDate",
"alreadySuspended": false
}POST /bff/organisation/lifecycle/suspend
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"
}'All BizKitHub public API endpoints require authentication via API key.