DocsAPI ReferenceContact/bff/contact/detail-change-email-preview
postContactAdmin BFF

/bff/contact/detail-change-email-preview

Returns whether submitting the given e-mail would be a no-op, a plain rename, or a merge with an existing contact. Designed for live ajax feedback as the operator types into the change-email form.

ContactpostBffContactDetail-change-email-preview

Parameters

2 body

2 total
Body · 2
idstringRequired

Contact external ID.

newEmailstringRequired

Candidate new e-mail address (may be unnormalized).

Request

POST /bff/contact/detail-change-email-preview

post
curl -X POST "https://api.bizkithub.com/bff/contact/detail-change-email-preview" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "example_id",
  "newEmail": "example_newEmail"
}'

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