/bff/contact/add-groups

Adds one or more groups to a contact identified by email or cuRefNo (at least one is required; cuRefNo takes precedence when both are supplied). Idempotent — groups already assigned to the contact are silently skipped, and groups that do not exist yet in the organisation are auto-created.

ContactpostBffContactAdd-groups

Parameters

JSON body

Request body

application/json

emailstringOptional

Contact email address.

The system validates the input as a standard email address and automatically applies normalization and canonicalization.

All API responses return the normalized form, and each email address is unique per organisation within the system.

Phone-only contacts: Since 2026-06-10 a contact may exist without an e-mail when it was registered only by phone (e.g. imports of phone-only records). Responses that expose such contacts use API_EMAIL_NULLABLE instead, where this field can be null. Endpoints that accept e-mail as input still require a valid value here — phone-only creation goes through admin-only import / BFF flows.

Examplejan@barasek.com

cuRefNostringOptional

Contact external ID.

Exampleabc123def456ghij

groupsstring[]Required

List of group slugs to assign. Non-slug input is normalised via toSlug. Groups that do not exist yet in the organisation are auto-created.

Response schema

1 status code documented

200Success

success"true"Required

Response example

application/json

{
  "success": true
}

Request example

POST /bff/contact/add-groups

post

curl -X POST "https://api.bizkithub.com/bff/contact/add-groups" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "email": "jan@barasek.com",
  "cuRefNo": "abc123def456ghij",
  "groups": [
    "personal-training"
  ]
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key