BizKitHub
DocsAPI ReferenceContact/bff/contact/remove-groups
postContactAdmin BFF

/bff/contact/remove-groups

Counterpart of /add-groups. Removes the listed groups from a contact identified by email or cuRefNo (at least one is required; cuRefNo takes precedence). Every other group and every other contact field stays unchanged. Idempotent: groups the contact does not have are skipped. The groups themselves are never deleted, even when no contact is left in them.

ContactpostBffContactRemove-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.

cuRefNostringOptional

Contact external ID.

Exampleabc123def456ghij
groupsstring[]Required

List of group slugs to remove (1 to 20). Non-slug input is normalised via toSlug. Slugs the contact does not have, or that do not exist in the organisation, are skipped.

Response schema

1 status code documented

200Success
success"true"Required
removedstring[]Required

Group slugs the contact really had and that were removed (empty when nothing changed).

Response example

application/json
{
  "success": true,
  "removed": [
    "string"
  ]
}

Request example

POST /bff/contact/remove-groups

post
curl -X POST "https://api.bizkithub.com/bff/contact/remove-groups" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "email": "[email protected]",
  "cuRefNo": "abc123def456ghij",
  "groups": [
    "trainer"
  ]
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key