Update filter

PUT /data/user/filters/{filter_id}
Jwt authorization

Update an existing filter if it is owned by the current user.

Path parameters

  • filter_id string(uuid) Required

    Filter unique identifier

application/json

Body Required

  • name string

    Filter name

  • search_query string

    Updated filter query

  • search_filter_group_id string(uuid)

    Filter group identifier

  • is_shared boolean

    Whether to share this filter

  • project_id string(uuid)

    Project identifier

  • department_id string(uuid)

    Department identifier

Responses

  • 200 application/json

    Filter updated successfully

    Hide response attributes Show response attributes object
    • id string(uuid)

      Filter unique identifier

    • name string

      Filter name

    • query string

      Filter query JSON

    • list_type string

      List type

    • entity_type string

      Entity type

    • project_id string(uuid)

      Project identifier

    • is_shared boolean

      Whether filter is shared

    • created_at string(date-time)

      Creation timestamp

    • updated_at string(date-time)

      Last update timestamp
PUT /data/user/filters/{filter_id} 
curl \
 --request PUT 'http://api.example.com/data/user/filters/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"Updated Filter Name","search_query":"{\"status\": \"active\"}","search_filter_group_id":"b35b7fb5-df86-5776-b181-68564193d36","is_shared":true,"project_id":"c46c8gc6-eg97-6887-c292-79675204e47","department_id":"d57d9hd7-fh08-7998-d403-80786315f58"}'
Request examples 
{
  "name": "Updated Filter Name",
  "search_query": "{\"status\": \"active\"}",
  "search_filter_group_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "is_shared": true,
  "project_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "department_id": "d57d9hd7-fh08-7998-d403-80786315f58"
}
Response examples (200) 
{
  "id": "e68e0ie8-gi19-8009-e514-91897426g69",
  "name": "Updated Filter Name",
  "query": "{\"status\": \"active\"}",
  "list_type": "todo",
  "entity_type": "Asset",
  "project_id": "f79f1jf9-hj20-9010-f625-a09008537h80",
  "is_shared": true,
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}