---
title: "createFilter"
canonical: "https://support.appfire.com/space/PSJ/15485117/createFilter"
format: markdown
---
> Macro (aura-html)


|  |  |  |  |
| --- | --- | --- | --- |
| **Syntax** | createfilter(filterName, filterDescription, filterQuery, ownerName) | **Package** |  |
| **Alias** |  | **Pkg Usage** |  |

## Description

> Macro (excerpt)
> 
> Creates a filter with name, description, search query, and owner.

Creates a filter with name, description, search query, and owner.

## Parameters

| Parameter name | Type | Required | Description |
| --- | --- | --- | --- |
| filterName | String | Yes | The filter name |
| filterDescription | String | No | The filter description |
| filterQuery | String | Yes | The JQL search string used by the filter |
| ownerName | String | Yes | The username or of the filter owner |

## Return Type

**Number**

Returns the id of the created filter.

## Example

```
number filterId = createfilter("Filter for Agile project", "Filter for Agile project", "project = \"Agile Project\" AND statusCategory not in (Done)", "admin");
```

## See also

> Macro (contentbylabel)