> For the complete documentation index, see [llms.txt](https://docs.fieldmotion.com/fieldmotion-api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fieldmotion.com/fieldmotion-api-docs/userfilter/_setname.md).

# \_setName

Set or change the name of a User Filter

### Examples

These examples use a created User Filter which has 105 as it's ID, and change it's name (represented by 'val') to "Test Filter" and "Tested Filter", respectively.

```
FM_api(
    'UserFilter_setName',[
        'id' => '105',
        'val' => 'Test Filter'
    ]
);
```

```
FM_api(
    'UserFilter_setName',[
        'id' => '105',
        'val' => 'Tested Filter'
    ]
);
```

#### On Success

Will give this message if the Filter was given a unique name.

```
{"ok":1}
```

Will give the following message instead if the name was already given from a previous run.

```
{"ok":1,"warning":"No change needed"}
```

#### On Failure

If the chosen ID is less than 1 or there's no chosen ID:

```
{"error":"missing or invalid parameter: id"}
```

If an ID is chosen but there's no User Filter created which has that ID\
(Change the "id" variable entry to the ID of an existing User Filter to remedy this) 

```
{"error":"filter with that ID does not exist"}
```

If the "val" variable is blank or not included

```
{"error":"no val parameter supplied, or it is blank"}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.fieldmotion.com/fieldmotion-api-docs/userfilter/_setname.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.