/bff/contact-credit/reason/create

Creates a new credit reason for the organisation.

Contact CreditpostBffContact-creditReasonCreate

Parameters

6 body

6 total

Body · 6

namestringRequired

Display name.

codestring

Unique code (slug-like). Auto-generated from name when omitted.

descriptionstring

Internal description shown in admin.

defaultAmountnumberRequired

Default credit amount when this reason is selected.

defaultAmountMoneynumber

Default monetary value in the organisation default currency. Omit to inherit from defaultAmount (1:1).

activeboolean

Whether the reason is selectable. Defaults to true.

Request

POST /bff/contact-credit/reason/create

post

curl -X POST "https://api.bizkithub.com/bff/contact-credit/reason/create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "name": "Reklamace úklidu",
  "code": "cleaning-complaint",
  "description": "example_description",
  "defaultAmount": 50,
  "defaultAmountMoney": 50,
  "active": false
}'

Response

JSON payload

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

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key