/bff/contact-segment/update

Partial update — only provided fields change. Editing the definition is validated against the field registry.

ContactpostBffContact-segmentUpdate

Parameters

5 body

5 total

Body · 5

idstringRequired

Segment external ID.

namestring

Length: 1–128

descriptionstring | null

definitionobject | object

isActiveboolean

Request

POST /bff/contact-segment/update

post

curl -X POST "https://api.bizkithub.com/bff/contact-segment/update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "example_id",
  "name": "example_name",
  "isActive": false
}'

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