/bff/member/invite-email
Sends an invitation e-mail to join the organisation. If the e-mail already belongs to a registered user the member is added immediately (and the pre-granted permissions are applied); otherwise a pending invitation is created — admin can still edit its permissions before the invitee accepts.
Parameters
6 body
emailstringRequiredContact 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 first name pre-filled on the registration form.
lastNamestringOptional last name pre-filled on the registration form.
permissionCodesstring[]Permission codes to grant when the invitation is accepted.
roleCodesstring[]Role codes to grant when the invitation is accepted.
descriptionstringInternal note about this invitation.
Request
POST /bff/member/invite-email
curl -X POST "https://api.bizkithub.com/bff/member/invite-email" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"email": "jan@barasek.com",
"firstName": "example_firstName",
"lastName": "example_lastName",
"permissionCodes": [
"string"
],
"roleCodes": [
"string"
],
"description": "example_description"
}'Response
JSON payload
{
"success": true,
"memberId": "example_memberId"
}All response codes
1 status code documented
Need an API key?
All BizKitHub API endpoints require authentication via API key.