BizKitHub
DocsAPI ReferenceMember/bff/member/invite-email
postMemberAdmin BFF

/bff/member/invite-email

Sends an invitation e-mail to join the organisation. Every invite becomes a pending row in cas__user_request_member and is only materialised into an active member once the invitee explicitly accepts (via /signup/member?token=… if new to the platform, or /onboarding if they already have a BKH account). Pre-granted permissions / roles ride on the pending row and are applied at acceptance; the admin may still edit them in the meantime.

MemberpostBffMemberInvite-email

Parameters

JSON body

Request body

application/json
emailstringRequired

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.

firstNamestringOptional

Optional first name pre-filled on the registration form.

Length: 0–128
lastNamestringOptional

Optional last name pre-filled on the registration form.

Length: 0–128
permissionCodesstring[]Optional

Permission codes to grant when the invitation is accepted.

roleCodesstring[]Optional

Role codes to grant when the invitation is accepted.

descriptionstringOptional

Internal note about this invitation.

Response schema

1 status code documented

200Success
successbooleanRequired
Default: true
status"pending"Required
memberIdstringRequired

Pending member id (pending-<token>) — for routing to detail.

userExistsbooleanRequired

True when the invitee already had a cas__user and received the accept-flavoured e-mail.

replacedExistingTokenbooleanRequired

True when a previous pending invite for the same (org, email) was overwritten; the old token is now invalid.

Response example

application/json
{
  "success": true,
  "status": "pending",
  "memberId": "example_memberId",
  "userExists": false,
  "replacedExistingToken": false
}

Request example

POST /bff/member/invite-email

post
curl -X POST "https://api.bizkithub.com/bff/member/invite-email" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "email": "[email protected]",
  "firstName": "example_firstName",
  "lastName": "example_lastName",
  "permissionCodes": [
    "string"
  ],
  "roleCodes": [
    "string"
  ],
  "description": "example_description"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key