Docs API Reference Complaint/bff/complaint/add-event

/bff/complaint/add-event

Adds a new event to the complaint timeline. Use for internal notes or customer-facing messages. Set shareWithCustomer=true to make the event visible to the customer.

ComplaintpostBffComplaintAdd-event

Parameters

JSON body

Request body

application/json

complaintIdstringRequired

Complaint external ID.

Examplea1b2c3d4

shareWithCustomerbooleanOptional

Indicator of whether this event should be visible to the customer. Defaults to false (internal only).

Default: false

subjectstringOptional

Event subject line.

ExampleInspection result

messagestringOptional

Event message body. Supports internal notes or customer-facing communication.

ExampleProduct defect confirmed. Replacement will be shipped.

Response schema

1 status code documented

200Success

successbooleanRequired

Indicates whether the operation completed successfully.

Default: true

Response example

application/json

{
  "success": true
}

Request example

POST /bff/complaint/add-event

post

curl -X POST "https://api.bizkithub.com/bff/complaint/add-event" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "complaintId": "a1b2c3d4",
  "shareWithCustomer": false,
  "subject": "Inspection result",
  "message": "Product defect confirmed. Replacement will be shipped."
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key