/bff/contact/update-internal-notice

Single-field update of the internal notice on a contact — used by the inline-edit affordance on the contact detail. Endpoint /detail-edit still updates the full profile.

ContactpostBffContactUpdate-internal-notice

Parameters

JSON body

Request body

application/json

customerIdstringRequired

Contact external ID.

internalNoticestringRequired

Internal note visible only to staff.

Response schema

1 status code documented

200Success

successbooleanRequired

Default: true

Response example

application/json

{
  "success": true
}

Request example

POST /bff/contact/update-internal-notice

post

curl -X POST "https://api.bizkithub.com/bff/contact/update-internal-notice" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "customerId": "example_customerId",
  "internalNotice": "example_internalNotice"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key