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

12 body

12 total

Body · 12

leadIdnumberRequired

Lead ID to update.

subjectstring

Length: 1–∞

descriptionstring

sourcestring | string | string | string | string

How the lead was acquired.

Lead pipeline status.

assignedMemberIdnumber | null

customerIdnumber | null

estimatedValuenumber | null

followUpDatestring | null

closedDatestring | null

lostReasonstring | null

internalNotestring | null

Request

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"
}'

Response

JSON payload

{
  "success": false
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key