BizKitHub
DocsInteractive API Docs/api/v1/newsletter/register-contact
post

/api/v1/newsletter/register-contact

API endpoint documentation

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, 6 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

emailstringrequired

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.

sourcestring
groupsstring[]
phonestring

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).

firstNamestring
lastNamestring

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/newsletter/register-contact?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "email": "jan@barasek.com",
    "source": "web",
    "groups": [
      []
    ],
    "phone": "+420 777123456",
    "firstName": "Jan",
    "lastName": "Barášek"
  })
});

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/newsletter/register-contact?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "jan@barasek.com",
  "source": "web",
  "groups": [
    []
  ],
  "phone": "+420 777123456",
  "firstName": "Jan",
  "lastName": "Barášek"
}'

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key
Back to API DocumentationAPI Reference