Objects

Delete a lead

Soft delete a lead by lead ID.

Overview

Use this endpoint to soft delete a lead in the token-bound tenant and project. It requires public api oauth access token authentication and the crm.leads.delete scope.

DELETE/api/crm/objects/leads/{leadId}

cURL

DELETE

bash

curl --request DELETE \  --url 'https://crm.notifyy.io/api/crm/objects/leads/55' \  --header 'Authorization: Bearer nfy_public_api_access_token'

Authorization

Public API OAuth access token

crm.leads.delete

Sample Request Body

This endpoint does not require a request body.

Sample Response

json

{  "success": true,  "message": "Lead deleted successfully",  "data": null}

Status Codes

Code	Description
200	Lead was deleted.

Headers

AuthorizationstringRequired

Public API OAuth bearer token.

Example: Bearer nfy_public_api_access_token

Object	Description
Authorization string	RequiredPublic API OAuth bearer token. Example: Bearer nfy_public_api_access_token

Path parameters

leadIdintegerRequired

Lead ID.

Example: 55

Object	Description
leadId integer	RequiredLead ID. Example: 55

Response fields

datanull

No response payload is returned for a successful delete.

Object	Description
data null	No response payload is returned for a successful delete.