/bff/contact-segment/create

Creates an empty contact segment with the supplied name. The filter definition starts empty and can be edited via /update.

ContactpostBffContact-segmentCreate

Parameters

JSON body

Request body

application/json

namestringRequired

Segment display name.

Length: 1–128

descriptionstringOptional

Optional description.

Length: 0–512

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json

{
  "success": true
}

Request example

POST /bff/contact-segment/create

post

curl -X POST "https://api.bizkithub.com/bff/contact-segment/create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "name": "example_name",
  "description": "example_description"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key