PlatformDocs
MCP server

update_filter

Marks a saved leads filter as a favourite (shown first) or not.

View as Markdown

Favourite a saved filter · Changes data

Marks a saved leads filter as a favourite (shown first) or not. Returns 404 when the filter is not one of this website's.

ConnectionAccount URL, team member URL or OAuth

Parameters

ParameterTypeRequiredAcceptsDescription
websiteIdstringYesanyWebsite ID from list_websites.
filterIdstringYesany_id from list_filters.
isFavoritebooleanYesanytrue to favourite it, false to un-favourite.

Tool definition

What your assistant receives from tools/list:

{
  "name": "update_filter",
  "title": "Favourite a saved filter",
  "annotations": {
    "title": "Favourite a saved filter",
    "readOnlyHint": false,
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "websiteId": {
        "type": "string",
        "description": "Website ID from list_websites."
      },
      "filterId": {
        "type": "string",
        "description": "_id from list_filters."
      },
      "isFavorite": {
        "type": "boolean",
        "description": "true to favourite it, false to un-favourite."
      }
    },
    "required": [
      "websiteId",
      "filterId",
      "isFavorite"
    ]
  }
}

On this page