/bff/workflow/update

Updates an existing workflow status including its automation rules (auto-pay, invoice, redirect).

WorkflowpostBffWorkflowUpdate

Parameters

JSON body

Request body

application/json

labelstringRequired

Display label for the status.

ExampleOdesláno

codestringRequired

Status code to update (identifies the status).

Exampleodeslano

internalNamestringOptional

Internal name visible only to staff.

publicLabelstringOptional

Public-facing label shown to customers.

colorstringRequired

Hex color for the status badge.

Example#22c55e

markAsPaidbooleanRequired

Automatically mark order as paid when entering this status.

createInvoicebooleanRequired

Automatically create invoice when entering this status.

createReceiptbooleanRequired

Automatically create receipt when entering this status.

redirectToCodestringOptional

Status code to auto-redirect to after timeout.

Exampledone

redirectTimeoutstringOptional

Relative time before redirect (e.g. "2h", "1d").

Example2h

Response schema

1 status code documented

200Success

successbooleanRequired

Default: true

Response example

application/json

{
  "success": true
}

Request example

POST /bff/workflow/update

post

curl -X POST "https://api.bizkithub.com/bff/workflow/update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "label": "Odesláno",
  "code": "odeslano",
  "internalName": "example_internalName",
  "publicLabel": "example_publicLabel",
  "color": "#22c55e",
  "markAsPaid": false,
  "createInvoice": false,
  "createReceipt": false,
  "redirectToCode": "done",
  "redirectTimeout": "2h"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key