/bff/cms/create-organisation-check

Checks if the proposed organisation name is available and generates a unique URL slug. Use this endpoint before creating an organisation to validate the name.

CMSpostBffCmsCreate-organisation-check

Parameters

JSON body

Request body

application/json

organisationNamestringRequired

Proposed organisation name to check availability.

ExampleAcme Corp

Response schema

1 status code documented

200SuccessOrganisation name availability check result.

availablebooleanRequired

Whether the organisation name is available for use.

Exampletrue

namestringRequired

The organisation name that was checked.

ExampleAcme Corp

slugstringRequired

Generated URL-friendly slug for the organisation. Guaranteed to be unique.

Exampleacme-corp

Response example

application/json

{
  "available": true,
  "name": "Acme Corp",
  "slug": "acme-corp"
}

Request example

POST /bff/cms/create-organisation-check

post

curl -X POST "https://api.bizkithub.com/bff/cms/create-organisation-check" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "organisationName": "Acme Corp"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key