DocsAPI ReferenceCms/bff/cms/create-organisation-check
postCmsAdmin BFF

/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

1 body

1 total
Body · 1
organisationNamestringRequired

Proposed organisation name to check availability.

Request

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"
}'

Response

Organisation name availability check result.

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

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key