/bff/lead/create

Creates a new lead/inquiry. Optionally creates or links an existing customer by email. The lead starts in "new" status.

LeadpostBffLeadCreate

Parameters

JSON body

Request body

application/json

subjectstringRequired

Lead subject/title.

Length: 1–∞

descriptionstringOptional

Detailed description of the inquiry.

source"web_form" | "phone" | "email" | "referral" | "other"Optional

How the lead was acquired.

customerEmailstringOptional

Customer email — creates or finds existing contact.

customerPhonestringOptional

Customer phone.

customerFirstNamestringOptional

Customer first name.

customerLastNamestringOptional

Customer last name.

assignedMemberIdnumberOptional

Organisation member ID to assign.

estimatedValuenumberOptional

Estimated deal value.

followUpDatestringOptional

Next follow-up date (ISO timestamp).

Example2026-03-01

internalNotestringOptional

Internal note for the sales team.

Response schema

1 status code documented

200Success

successbooleanRequired

idnumberRequired

Created lead ID.

Response example

application/json

{
  "success": false,
  "id": 0
}

Request example

POST /bff/lead/create

post

curl -X POST "https://api.bizkithub.com/bff/lead/create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "subject": "example_subject",
  "description": "example_description",
  "customerEmail": "example_customerEmail",
  "customerPhone": "example_customerPhone",
  "customerFirstName": "example_customerFirstName",
  "customerLastName": "example_customerLastName",
  "assignedMemberId": 0,
  "estimatedValue": 0,
  "followUpDate": "2026-03-01",
  "internalNote": "example_internalNote"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key