/bff/contact/detail-change-email
Changes the primary email address of a contact. Requires the current email for verification. When the target e-mail is already taken by another contact in the same organisation, the call fails unless confirmMerge: true is provided, in which case the duplicate is merged into the current contact first.
Parameters
5 body
idstringRequiredContact external ID.
currentEmailstringRequiredContact 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.
newEmailstringRequiredContact 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.
reasonstringRequiredReason for the email change.
confirmMergebooleanSet to true to acknowledge that another contact already owns the target e-mail; that contact will be merged into the current one before the rename.
Request
POST /bff/contact/detail-change-email
curl -X POST "https://api.bizkithub.com/bff/contact/detail-change-email" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"id": "example_id",
"currentEmail": "jan@barasek.com",
"newEmail": "jan@barasek.com",
"reason": "example_reason",
"confirmMerge": false
}'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.