Create a lead | JazzHQ AI

curl -X POST https://api.jazzhq.ai/api/v1/vendors/partners/1/leads \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "firstName": "Jane",
  "emailAddress": "jane@acme.com",
  "companyName": "Acme Inc"
}'

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

Creates a lead against the partner in the path and the vendor your API key belongs to. Ownership is never read from the request body.

Authentication

X-API-KEYstring

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

Path parameters

partnerIdlongRequired

ID of the partner the lead belongs to.

Request

This endpoint expects an object.

firstNamestringRequired

emailAddressstringRequiredformat: "email"

companyNamestringRequired

lastNamestring or nullOptional

phoneNumberstring or nullOptional

linkedInUrlstring or nullOptional

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

successbooleanOptional

messagestring or nullOptional

dataobjectOptional

timestampdatetimeOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error