Delete Lead
Permanently remove a lead from the system. This operation cannot be undone.
🔹 Endpoint Details
DELETE /api/v1/leads/{id}
🔒 Authentication
| Header | Required | Description |
|---|---|---|
| Content-Type | Yes | Must be application/json |
| Authorization | Yes | Format: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature |
📝 Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string (UUID) | Yes | ID of the lead to delete |
🧩 Request Example
curl -X DELETE "https://openapi.onlive.site/api/v1/leads/123e4567-e89b-12d3-a456-426614174000" \
-H "Content-Type: application/json" \
-H "Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature"
📥 Response
Success Response (200 OK)
Returns the deleted Lead entity.
Response Example
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"organizationId": "123e4567-e89b-12d3-a456-426614174001",
"organizationName": "Acme Inc.",
"name": "John Doe",
"phone": "+33612345678",
"status": "created",
"userGroupId": "550e8400-e29b-41d4-a716-446655440000",
"userGroup": "Sales Team",
"labels": ["hotlead"],
"extraFields": { "source": "landing-page" },
"qualification": 0.75,
"sentToIntegration": false,
"locations": [],
"devices": [],
"origins": [],
"interactions": [],
"historics": [],
"createdAt": "2025-05-13T15:00:00Z",
"updatedAt": "2025-05-13T18:00:00Z"
}
❌ Error Responses
| Status | Description |
|---|---|
| 404 | Lead not found |
This endpoint follows the standard error format.
📘 Notes
- Deletion is permanent and cannot be undone
- The lead must belong to your organization
- You must have appropriate permissions to delete leads
✅ Common Use Cases
- 🧹 Cleanup: Remove duplicate or test leads
- 🔒 Compliance: Erase leads on right-to-be-forgotten requests
- 🗑️ Spam: Discard leads flagged as noise