BizKitHub
DocsAPI ReferenceWorkflow/bff/workflow/group-update
postWorkflowAdmin BFF

/bff/workflow/group-update

Updates editable fields of an order group. Only provided fields are touched.

WorkflowpostBffWorkflowGroup-update

Parameters

JSON body

Request body

application/json
codestringRequired

Code of the group to update.

Exampledefault
namestringOptional

New display name.

descriptionstring | nullOptional
One of 2:
Variant 1
string

New description, or null to clear.

Variant 2
null
activebooleanOptional

Activate or deactivate the group. Default group cannot be deactivated.

dueDateRelativeTimestringOptional

New due-date offset.

Example14d
invoicePrefixstring | nullOptional
One of 2:
Variant 1
string

New invoice prefix, or null to clear.

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

Contact ID of the invoice issuer override, or null to clear.

Variant 2
null
forceInvoicebooleanOptional

When true, any paid order in this group is issued a full invoice regardless of country/threshold rules; the create_receipt flag on statuses is suppressed. Used for internal-party billing (franchise settlement) where a simplified receipt is not appropriate.

useSystemDefaultNotificationsbooleanOptional

When true, sendOrderStatusNotification bypasses this organisation's custom email templates and per-group bindings and sends the platform-baked default template keyed by the 4 status types (new / processing / storno / done). Enable when the group hosts a flow (consulting, real-estate handoff, e-shop upsell inside a reservation-focused org) that does not fit the org's regular custom-template copy.

preferBankTransferPaymentbooleanOptional

When true, the system-default "order received" e-mail resolves the payment block to bank transfer instructions (IBAN + variable symbol + payment QR) instead of the "Zaplatit online" button, provided the organisation has a bank account for the order currency and the order carries a variable symbol. Card payments through configured gateways still work — only the confirmation e-mail changes.

Response schema

1 status code documented

200Success
successbooleanRequired
Default: true

Response example

application/json
{
  "success": true
}

Request example

POST /bff/workflow/group-update

post
curl -X POST "https://api.bizkithub.com/bff/workflow/group-update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "code": "default",
  "name": "example_name",
  "active": false,
  "dueDateRelativeTime": "14d",
  "forceInvoice": false,
  "useSystemDefaultNotifications": false,
  "preferBankTransferPayment": false
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key