/api/v1/customer/update-profile

API endpoint documentation

post

Tags:customer

Operation ID: postApiV1CustomerUpdate-profile

Query Parameters

apiKeystring

required

Your BizKitHub API key (passed as GET parameter)

Get API Key →

Body

emailstring

required

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.

Example: "jan@barasek.com"

namestring

optional

Example: "Jan Barášek"

firstNamestring

optional

Example: "Jan"

lastNamestring

optional

Example: "Barášek"

phonestring

optional

Contact phone number in international (national) format.

Preferred format: +<country_code> <local_number>

Leading plus sign (+) is required
Followed by the country calling code (e.g. 420)
One space after the country code
Full local number without spaces

Example: +420 777123456
This format ensures unambiguous storage, validation, and compatibility with SMS, calling, and third-party integrations (e.g. Twilio, WhatsApp, CRM systems).

Example: "+420 777123456"

companyNamestring

optional

Example: "BRJ"

companyRegistrationNumberstring

optional

Example: "05103118"

taxIdentificationNumberstring

optional

Example: "CZ9609040727"

streetAddressstring

optional

Example: "R. Novotného 1505"

citystring

optional

Example: "Kladno"

cityPartstring

optional

Example: "Kročehlavy"

stateRegionstring

optional

Example: "Středočeský kraj"

postalCodestring

optional

Example: "272 01"

countrystring

optional

Example: "CZ"

newsletterboolean

optional

primaryLocalestring

optional

Example: "cs"

groupsarray

optional

customerRealIpstring

optional

Example: "1.1.1.1"

referralIdstring

optional

cuRefNo = customer reference number.

Example: "1cGIHvFoQDGLAbcA"

Responses

200

No description

Base URL:

https://bizkithub.com

Example Request

fetch('https://bizkithub.com/api/v1/customer/update-profile?apiKey=YOUR_API_KEY', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
        "email": "jan@barasek.com",
        "name": "Jan Barášek",
        "firstName": "Jan",
        "lastName": "Barášek",
        "phone": "+420 777123456",
        "companyName": "BRJ",
        "companyRegistrationNumber": "05103118",
        "taxIdentificationNumber": "CZ9609040727",
        "streetAddress": "R. Novotného 1505",
        "city": "Kladno",
        "cityPart": "Kročehlavy",
        "stateRegion": "Středočeský kraj",
        "postalCode": "272 01",
        "country": "CZ",
        "newsletter": false,
        "primaryLocale": "cs",
        "groups": [],
        "customerRealIp": "1.1.1.1",
        "referralId": "1cGIHvFoQDGLAbcA"
    })
})

Example Response

HTTP 200Success Response

{
  "success": false
}

🔑 API Key Required

All BizKitHub API endpoints require authentication using an API key. The API key must be passed as a GET parameter in the URL for all requests.

Get API Key →API Overview →

Back to API Documentation

Last updated: January 2, 2026