BizKitHub
DocsInteractive API Docs/api/v1/customer/customer-match-customer
post

/api/v1/customer/customer-match-customer

Create many-to-many relation between two customers.

This feature is suitable, for example, for matching clients and trainers, or for obtaining contacts on a dating site or company contact.

Endpoint Info
Base URLapi.bizkithub.com
AuthBearer Token
Methods1
Authentication Required

This endpoint requires a valid API key passed as a query parameter or Bearer token.

Get your API key

Parameters

1 query, 4 body parameters

apiKeystringrequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

managerCuRefNostringrequired

cuRefNo = customer reference number.

Length: 16 - 16
customerCuRefNostring

Customer of relation.

customerEmailstring

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 globally unique per contact within the system.

noticestring

A public note for this connection. The note will be visible to both customers. For example, a trainer can write information about a new client here.

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/customer/customer-match-customer?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "managerCuRefNo": "1cGIHvFoQDGLAbcA",
    "customerCuRefNo": "5CmsaVNgAQqRqoen",
    "customerEmail": "jan@barasek.com",
    "notice": "Customer prefers cardio training. Contact obtained via the website."
  })
});

const data = await response.json();
console.log(data);
post

Example Response

200Success
{
  "success": true
}

cURL

Command line example

curl -X POST "https://api.bizkithub.com/api/v1/customer/customer-match-customer?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -d '{
  "managerCuRefNo": "1cGIHvFoQDGLAbcA",
  "customerCuRefNo": "5CmsaVNgAQqRqoen",
  "customerEmail": "jan@barasek.com",
  "notice": "Customer prefers cardio training. Contact obtained via the website."
}'

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key
Back to API DocumentationAPI Reference