# hide_lead (/docs/mcp/tools/hide-lead)

{/* Generated by scripts/sync-mcp-tools.mjs from happierleads-api. Do not edit: change src/routes/mcp/toolDocs.json there, or add content/mcp-notes/hide_lead.mdx. */}

**Hide or unhide a lead** · Changes data

Hide a lead from the leads list (hide=true, the default) or bring a hidden lead back (hide=false). Hidden leads no longer appear in get_leads. Hiding is reversible and keeps the lead's data; it does not give back the credit the lead used. To remove a lead for good use delete_lead. leadId comes from get_leads. Returns status 'Successful'; hiding an already hidden lead returns an error 'Lead is already hidden.'

| Connection | Account URL, team member URL or OAuth |
| --- | --- |

## Parameters [#parameters]

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `leadId` | `string` | Yes | Lead id (the _id of a row returned by get_leads). |
| `hide` | `boolean` | No | true (default) hides the lead; false makes a hidden lead visible again. |

## Tool definition [#tool-definition]

What your assistant receives from `tools/list`:

```json
{
  "name": "hide_lead",
  "title": "Hide or unhide a lead",
  "annotations": {
    "title": "Hide or unhide a lead",
    "readOnlyHint": false,
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "leadId": {
        "type": "string",
        "description": "Lead id (the _id of a row returned by get_leads)."
      },
      "hide": {
        "type": "boolean",
        "description": "true (default) hides the lead; false makes a hidden lead visible again."
      }
    },
    "required": [
      "leadId"
    ]
  }
}
```