/api/v1/newsletter/register-contact

Registers a new contact for the newsletter. If the contact already exists, it is updated with the provided data. Optionally assigns the contact to one or more newsletter groups.

newsletterpostApiV1NewsletterRegister-contact

Parameters

1 query · 6 body

7 total

Query · 1

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

Body · 6

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

sourcestring

Signup source identifier for analytics.

groupsstring[]

Newsletter group tags to assign to the contact.

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

Request

POST /api/v1/newsletter/register-contact

post

curl -X POST "https://api.bizkithub.com/api/v1/newsletter/register-contact?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "email": "jan@barasek.com",
  "source": "web",
  "groups": [
    "trainer"
  ],
  "phone": "+420 777123456",
  "firstName": "Jan",
  "lastName": "Barášek"
}'

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