/bff/workflow/update

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

WorkflowpostBffWorkflowUpdate

Parameters

10 body

10 total

Body · 10

labelstringRequired

Display label for the status.

codestringRequired

Status code to update (identifies the status).

internalNamestring

Internal name visible only to staff.

publicLabelstring

Public-facing label shown to customers.

colorstringRequired

Hex color for the status badge.

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.

redirectToCodestring

Status code to auto-redirect to after timeout.

redirectTimeoutstring

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

Request

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

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