DocsAPI ReferenceContact/bff/contact-segment/preview
postContactAdmin BFF

/bff/contact-segment/preview

Translates the definition to SQL and returns the first 50 matching contacts without persisting anything.

ContactpostBffContact-segmentPreview

Parameters

1 body

1 total
Body · 1
definitionobject | objectRequired

Request

POST /bff/contact-segment/preview

post
curl -X POST "https://api.bizkithub.com/bff/contact-segment/preview" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'

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