/bff/workflow/group-update

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

WorkflowpostBffWorkflowGroup-update

Parameters

8 body

8 total

Body · 8

codestringRequired

Code of the group to update.

namestring

New display name.

descriptionstring | null

activeboolean

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

dueDateRelativeTimestring

New due-date offset.

invoicePrefixstring | null

invoiceIssuerIdnumber | null

forceInvoiceboolean

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.

Request

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

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key