DocsAPI ReferenceOrder/bff/order/update-notice
postOrderAdmin BFF

/bff/order/update-notice

Updates the internal and public notice texts on the order.

OrderpostBffOrderUpdate-notice

Parameters

3 body

3 total
Body · 3
orderHashstringRequired

Unique order hash identifier.

internalNoticestringRequired

Internal note visible only to staff.

publicNoticestringRequired

Public note visible to the customer.

Request

POST /bff/order/update-notice

post
curl -X POST "https://api.bizkithub.com/bff/order/update-notice" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "orderHash": "example_orderHash",
  "internalNotice": "example_internalNotice",
  "publicNotice": "example_publicNotice"
}'

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