Docs API Reference Organisation/bff/organisation/update-profile

/bff/organisation/update-profile

Updates organisation profile fields. All fields are optional — only provided fields are updated. Direct organisation columns (name, vatPayer, etc.) are updated in the organisation table. Configuration values (SMTP, branding, etc.) are updated in the key-value configuration store. SMTP passwords are write-only and never returned in the profile GET endpoint. Clears the cache after successful update.

OrganisationpostBffOrganisationUpdate-profile

Parameters

47 body

47 total

Body · 47

namestring

Organisation display name. Sanitized on save (disallowed chars removed, first letter capitalized). Changes propagate to email sender names, invoices, and all UI displays.

Length: 1–255

descriptionstring | null

emojistring | null

companyRegistrationNumberstring | null

taxIdentificationNumberstring | null

vatPayerboolean

VAT payer flag. When true, invoices include VAT rates on line items and fraud checks run against the unreliable payer list. When false, all invoice items use 0% VAT.

accountingCountryIdnumber | null

legalFormIdnumber | null

disableExperimentsboolean

When true, disables AI-powered features (issue routing, AI responses in ticket workflow).

timezoneIdnumber

Default timezone ID (from GET /organisation/timezones). Used to format dates in email notifications and calendar event times. If a calendar has no specific timezone, this org default is used.

primaryLocaleIdnumber

Primary locale ID (from GET /organisation/available-locales). Used as default language for: new contacts without a locale preference, email template rendering, and newsletter digest post selection.

defaultCurrencystring

Requested default currency ISO 4217 code (e.g. "CZK"). Changing the default currency is NOT performed through this endpoint: if the provided code differs from the current default, the change is rejected, a warning is logged, and a technical notification is sent to the organisation asking them to contact BizKitHub technical support. Passing the current code is a no-op.

Length: 3–3

supportPersonIdnumber | null

logoUrlstring | null

printLogoUrlstring | null

primaryColorstring | null

secondaryColorstring | null

supportEmailstring | null

supportEmailMarketingstring | null

emailerFooterstring | null

emailerLayoutstring | null

emailerSmtpHoststring | null

emailerSmtpPortstring | null

emailerSmtpUserstring | null

emailerSmtpPasswordstring | null

emailerMarketingSmtpHoststring | null

emailerMarketingSmtpPortstring | null

emailerMarketingSmtpUserstring | null

emailerMarketingSmtpPasswordstring | null

emailerNewsletterReturnUrlstring | null

smsSluzbaCzLoginstring | null

smsSluzbaCzPasswordstring | null

smsSluzbaCzDefaultSenderstring | null

orderInternalNotificationEmailsstring | null

orderNewInternalNotificationEnabledboolean

Master switch for the BizKitHub-internal "new order created" notification e-mail. True = send from info@bizkithub.com to this organisation on every new order (throttled to 10 / UTC day). False (default) = disabled.

orderRefundStrategystring | null

orderAccountingModestring | null

logInternalNotificationEmailsstring | null

logReportDisabledboolean

Opt-out flag for the daily log report e-mail. False = receive (default), true = suppress. Critical-level errors are always delivered regardless of this flag.

postDigestEnabledboolean

Master switch for automatic newsletter digest. When enabled, a cron job periodically sends a digest of recent blog posts to all contacts with active newsletter subscriptions.

postDigestIntervalDaysnumber | null

postDigestSubjectstring | null

postDigestIntroTextstring | null

postDigestLocalestring | null

postDigestMaxPostsnumber | null

paymentRecurringEnabledboolean

Enable Comgate recurring payment charging. When true, allows card tokenization on first payment and automatic subsequent charges without customer re-auth. Required for subscription billing.

customerCreditDefaultExpirationstring | null

Request

POST /bff/organisation/update-profile

post

curl -X POST "https://api.bizkithub.com/bff/organisation/update-profile" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "name": "example_name",
  "vatPayer": false,
  "disableExperiments": false,
  "timezoneId": 0,
  "primaryLocaleId": 0,
  "defaultCurrency": "CZK",
  "orderNewInternalNotificationEnabled": false,
  "logReportDisabled": false,
  "postDigestEnabled": false,
  "paymentRecurringEnabled": false
}'

Response

JSON payload

{
  "success": false
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key