/bff/complaint/variant-create

Creates a new complaint variant type for the organisation.

ComplaintpostBffComplaintVariant-create

Parameters

JSON body

Request body

application/json

codestringRequired

Unique variant code within the organisation. Used as identifier in API calls.

Examplescomplaintreturnexchange

labelstringRequired

Human-readable variant label displayed in UI.

ExamplesComplaintReturn of goodsExchange

policyIdnumberOptional

Default complaint policy ID applied to this variant.

Example1

positionnumberOptional

Display order position. Lower values appear first.

Example0

Response schema

1 status code documented

200Success

successbooleanRequired

Indicates whether the operation completed successfully.

Default: true

idnumberRequired

Newly created variant ID.

Example1

Response example

application/json

{
  "success": true,
  "id": 1
}

Request example

POST /bff/complaint/variant-create

post

curl -X POST "https://api.bizkithub.com/bff/complaint/variant-create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "code": "complaint",
  "label": "Complaint",
  "policyId": 1,
  "position": 0
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key