Remove an address from a lead | PlannrCRM API documentation

Remove an address from 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/{lead_uuid}/addresses/{uuid}

Personal access token & O auth2

Detaches the address from the lead and soft deletes it only when no other lead or account is linked to it. Removing the primary address promotes the oldest remaining address.

Path parameters

lead_uuid string Required

The UUID of the lead.
uuid string Required

The UUID of the address.

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 or the address to another lead
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/{lead_uuid}/addresses/{uuid}

curl \
 --request DELETE 'https://api.plannrcrm.com/api/v1/leads/53f22fe4-3731-4cdc-aa12-e65bd0b15e52/addresses/6a6a176d-52bc-47f2-88c3-141d44059bcf' \
 --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": "This lead is archived and cannot be changed."
}