/bff/workflow/group-add

Creates a new order group for the organisation and attaches a workflow-status set to it via shop__order_group_status. Code uniqueness and invoice-prefix uniqueness are enforced. The group is created at the end of the position order.

WorkflowpostBffWorkflowGroup-add

Parameters

JSON body

Request body

application/json

namestringRequired

Display name of the new group.

ExampleReservations

codestringOptional

Optional stable code (slug). Auto-generated from name when omitted.

descriptionstringOptional

Free-form admin description.

dueDateRelativeTimestringOptional

Default due-date offset for new orders.

Example7d

invoicePrefixstringOptional

Optional invoice prefix (1–3 chars), unique per organisation.

statusCodesstring[]Optional

Optional explicit list of status codes to attach to the new group. When omitted, the link set is copied from the default group, or all org statuses are linked if no default group has links.

Response schema

1 status code documented

200Success

successbooleanRequired

Default: true

codestringRequired

Resolved group code (slugified).

Response example

application/json

{
  "success": true,
  "code": "example_code"
}

Request example

POST /bff/workflow/group-add

post

curl -X POST "https://api.bizkithub.com/bff/workflow/group-add" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "name": "Reservations",
  "code": "example_code",
  "description": "example_description",
  "dueDateRelativeTime": "7d",
  "invoicePrefix": "example_invoicePrefix",
  "statusCodes": [
    "string"
  ]
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key