_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"}