Archive a lead

PUT

https://api.jazzhq.ai/api/v1/vendors/leads/:leadId/archive

PUT

/api/v1/vendors/leads/:leadId/archive

curl -X PUT https://api.jazzhq.ai/api/v1/vendors/leads/1/archive \
     -H "X-API-KEY: <apiKey>"

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

Hides the lead from listings without deleting it. Safe to retry - archiving an already-archived lead succeeds and changes nothing.

Authentication

X-API-KEYstring

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

Path parameters

leadIdlongRequired

ID of the lead.

Response

Lead archived successfully.

successbooleanOptional

messagestring or nullOptional

dataobjectOptional

timestampdatetimeOptional

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error