Update a lead | JazzHQ AI

{
  "success": true,
  "message": "LEAD_CREATE_SUCCESSFUL",
  "data": {
    "id": 300,
    "partnerId": 1001,
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane@acme.com",
    "phoneNumber": "string",
    "linkedInUrl": "string",
    "companyName": "Acme Inc",
    "websiteUrl": "string",
    "companySize": "50-100",
    "industry": "string",
    "jobTitle": "VP Sales",
    "city": "string",
    "state": "string",
    "country": "string",
    "source": 1,
    "status": 1,
    "leadAge": 1,
    "productsInterested": "string",
    "businessImpactMetrics": "string",
    "externalId": "string",
    "approvalStatus": "PENDING",
    "rejectReason": "string",
    "rejectComment": "string",
    "lastActiveAt": "2024-01-15T09:30:00Z",
    "submittedByType": "PARTNER_USER",
    "isDuplicate": true,
    "archived": true,
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z"
  },
  "timestamp": "2024-01-15T09:30:00Z"
}

Updates only the fields present in the body; anything omitted keeps its stored value. Use PUT instead if you want omitted fields cleared.

Approval state and archiving are not settable here - use the approve, reject and archive endpoints.

Authentication

X-API-KEYstring

Your vendor API key. Required on every request under /api/v1/vendors/**.

Path parameters

leadIdlongRequired

ID of the lead.

Request

This endpoint expects an object.

firstNamestringOptional

lastNamestring or nullOptional

emailAddressstringOptionalformat: "email"

phoneNumberstring or nullOptional

linkedInUrlstring or nullOptional

companyNamestringOptional

websiteUrlstring or nullOptional

companySizestring or nullOptional

industrystring or nullOptional

jobTitlestring or nullOptional

citystring or nullOptional

statestring or nullOptional

countrystring or nullOptional

sourcelong or nullOptional

Id of a lead source dropdown value configured for your account.

statuslong or nullOptional

Id of a lead status dropdown value configured for your account.

leadAgeinteger or nullOptional

productsInterestedstring or nullOptional

businessImpactMetricsstring or nullOptional

externalIdstring or nullOptional

Your own identifier for this lead. Stored and echoed back unchanged.

Response

Lead updated successfully.

successbooleanOptional

messagestring or nullOptional

dataobjectOptional

timestampdatetimeOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error