PlatformDocs
MCP server

delete_lead

Permanently delete one or more leads.

View as Markdown

Delete leads permanently · Deletes or overwrites data

Permanently delete one or more leads. This cannot be undone, the credits they used are not given back, and the companies of the deleted leads are added to the website's blocked company domains (the Exclude list in Qualify), so new leads from those companies stop appearing. To only take a lead off the list, use hide_lead instead. leadIds come from get_leads. Confirm with the user before calling. Returns deletedCount, the number of leads actually deleted (leads outside your account are skipped).

ConnectionAccount URL, team member URL or OAuth

Parameters

ParameterTypeRequiredAcceptsDescription
leadIdsstring[]YesanyArray of lead ids (the _id values from get_leads), e.g. ["66f1...", "66f2..."]. Use leads from one website per call.

Tool definition

What your assistant receives from tools/list:

{
  "name": "delete_lead",
  "title": "Delete leads permanently",
  "annotations": {
    "title": "Delete leads permanently",
    "readOnlyHint": false,
    "destructiveHint": true,
    "idempotentHint": true,
    "openWorldHint": false
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "leadIds": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Array of lead ids (the _id values from get_leads), e.g. [\"66f1...\", \"66f2...\"]. Use leads from one website per call."
      }
    },
    "required": [
      "leadIds"
    ]
  }
}

On this page