postLeadAdmin BFF

/bff/lead/update

Updates lead fields. Only provided fields are changed. When status is set to "won" or "lost", closedDate is auto-set to now if not provided.

LeadpostBffLeadUpdate

Parameters

JSON body

Request body

application/json

leadIdnumberRequired

Lead ID to update.

subjectstringOptional

Length: 1–∞

descriptionstringOptional

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

How the lead was acquired.

Lead pipeline status.

assignedMemberIdnumber | nullOptional

One of 2:

Variant 1

number

Set assigned member, or null to unassign.

Variant 2

null

customerIdnumber | nullOptional

One of 2:

Variant 1

number

Set customer ID, or null to unlink.

Variant 2

null

estimatedValuenumber | nullOptional

One of 2:

Variant 1

number

Variant 2

null

followUpDatestring | nullOptional

One of 2:

Variant 1

string

ISO timestamp or null to clear.

Variant 2

null

closedDatestring | nullOptional

One of 2:

Variant 1

string

Variant 2

null

lostReasonstring | nullOptional

One of 2:

Variant 1

string

Reason for losing the lead (when status=lost).

Variant 2

null

internalNotestring | nullOptional

One of 2:

Variant 1

string

Variant 2

null

Response schema

1 status code documented

200Success

successbooleanRequired

Response example

application/json

{
  "success": false
}

Request example

POST /bff/lead/update

post

curl -X POST "https://api.bizkithub.com/bff/lead/update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "leadId": 0,
  "subject": "example_subject",
  "description": "example_description"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key