/bff/contact-credit/reason/create

Creates a new credit reason for the organisation.

Contact CreditpostBffContact-creditReasonCreate

Parameters

JSON body

Request body

application/json

namestringRequired

Display name.

ExampleReklamace úklidu

codestringOptional

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

Examplecleaning-complaint

descriptionstringOptional

Internal description shown in admin.

defaultAmountnumberRequired

Default credit amount when this reason is selected.

Example50

defaultAmountMoneynumberOptional

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

Example50

activebooleanOptional

Whether the reason is selectable. Defaults to true.

isCustomerCarebooleanOptional

Marks the reason as a customer-care event (reklamace / kompenzace / omluva). Credits linked to reasons with this flag contribute to the per-contact customer-care count that penalises repeat-recipients in the CRM score. Defaults to false.

Response schema

1 status code documented

200Success

successbooleanRequired

Default: true

externalIdstringRequired

Generated external ID (16 chars).

codestringRequired

Final code assigned to the reason.

Response example

application/json

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

Request example

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,
  "isCustomerCare": false
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key