BizKitHub
DocsAPI ReferenceComplaint/bff/complaint/add-event
postComplaintAdmin BFF

/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

4 body

4 total
Body · 4
complaintIdstringRequired

Complaint external ID.

shareWithCustomerboolean

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

Default: false
subjectstring

Event subject line.

messagestring

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

Request

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."
}'

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