/api/v1/customer/add-groups

Adds one or more groups to a customer identified by email or cuRefNo (at least one is required; cuRefNo takes precedence when both are supplied). Idempotent — groups already assigned to the customer are silently skipped, and groups that do not exist yet in the organisation are auto-created. Useful for tagging customers from analytics/automation flows when only the e-mail is known.

customerpostApiV1CustomerAdd-groups

Parameters

1 query · 3 body

4 total

Query · 1

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

Body · 3

emailstring

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.

cuRefNostring

cuRefNo = customer reference number.

Length: 16–16

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.

Request

POST /api/v1/customer/add-groups

post

curl -X POST "https://api.bizkithub.com/api/v1/customer/add-groups?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "email": "jan@barasek.com",
  "cuRefNo": "1cGIHvFoQDGLAbcA",
  "groups": [
    "personal-training"
  ]
}'

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