Delete a lead | PlannrCRM API documentation

Delete a lead Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

DELETE /api/v1/leads/{uuid}

Personal access token & O auth2

Only an archived lead can be deleted. Soft deletes the lead. Attached contact details and addresses are soft deleted only when nothing else links to them.

Path parameters

uuid string Required

The UUID of the lead.

Responses

403 application/json

Unauthorized
Hide response attribute Show response attribute object
- message string Required
  
  A human-readable description of the error.
404 application/json

Lead belongs to another firm
Hide response attribute Show response attribute object
- message string Required
  
  A human-readable description of the error.
409 application/json
Hide response attribute Show response attribute object
- message string Required
  
  A human-readable description of the error.

DELETE /api/v1/leads/{uuid}

curl \
 --request DELETE 'https://api.plannrcrm.com/api/v1/leads/53f22fe4-3731-4cdc-aa12-e65bd0b15e52' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (403)

{
  "message": "This action is unauthorized."
}

Response examples (404)

{
  "message": "Not Found"
}

Response examples (409)

{
  "message": "This lead has been promoted to a client and is locked."
}

{
  "message": "Archive the lead before deleting it."
}