BizKitHub
DocsAPI ReferenceAdmin/bff/admin/update-organisation-profile
postAdminAdmin BFF

/bff/admin/update-organisation-profile

Updates the profile of any organisation looked up by slug. Accepts a focused editable subset of the organisation profile — basic info, company/VAT identity, branding, notification e-mail routing, post digest, and payment. Delegates to updateOrganisationProfile. Requires internal admin membership.

AdminpostBffAdminUpdate-organisation-profile

Parameters

JSON body

Request body

application/json
slugstringRequired

Organisation slug to update.

Exampleacme-corp
namestringOptional

Organisation display name.

Length: 1255
descriptionstring | nullOptional
One of 2:
Variant 1
string

Free-form profile description.

Length: 05000
Variant 2
null
emojistring | nullOptional
One of 2:
Variant 1
string

Organisation emoji icon.

Length: 016
Variant 2
null
companyRegistrationNumberstring | nullOptional
One of 2:
Variant 1
string

Company registration number (IČO).

Length: 050
Variant 2
null
taxIdentificationNumberstring | nullOptional
One of 2:
Variant 1
string

Tax identification number (DIČ).

Length: 050
Variant 2
null
vatPayerbooleanOptional

VAT payer flag.

primaryColorstring | nullOptional
One of 2:
Variant 1
string

Primary brand hex colour (e.g. "#1a2b3c").

Variant 2
null
secondaryColorstring | nullOptional
One of 2:
Variant 1
string

Secondary brand hex colour.

Variant 2
null
supportEmailstring | nullOptional
One of 2:
Variant 1
string

Default "From" address for transactional emails.

Variant 2
null
supportEmailMarketingstring | nullOptional
One of 2:
Variant 1
string

Override "From" address for marketing emails.

Variant 2
null
orderInternalNotificationEmailsstring | nullOptional
One of 2:
Variant 1
string

Comma-separated internal notification e-mails for order events.

Variant 2
null
logInternalNotificationEmailsstring | nullOptional
One of 2:
Variant 1
string

Comma-separated internal notification e-mails for system-log events.

Variant 2
null
postDigestEnabledbooleanOptional

Enable the post digest newsletter.

postDigestSubjectstring | nullOptional
One of 2:
Variant 1
string

Post digest email subject.

Variant 2
null
postDigestIntroTextstring | nullOptional
One of 2:
Variant 1
string

Post digest email intro text.

Variant 2
null
postDigestIntervalDaysnumber | nullOptional
One of 2:
Variant 1
number

Post digest interval in days.

Variant 2
null
postDigestMaxPostsnumber | nullOptional
One of 2:
Variant 1
number

Maximum posts included in one digest.

Variant 2
null
paymentRecurringEnabledbooleanOptional

Enable recurring/tokenised payments.

customerCreditDefaultExpirationstring | nullOptional
One of 2:
Variant 1
string

Default expiration policy for customer credit.

Variant 2
null

Response schema

1 status code documented

200Success
successbooleanRequired

Whether the update succeeded.

Response example

application/json
{
  "success": false
}

Request example

POST /bff/admin/update-organisation-profile

post
curl -X POST "https://api.bizkithub.com/bff/admin/update-organisation-profile" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "slug": "acme-corp",
  "name": "example_name",
  "vatPayer": false,
  "postDigestEnabled": false,
  "paymentRecurringEnabled": false
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key