API ReferenceBoardsFilters

Update filter

View as Markdown

The token name itself comes from widget SQL and cannot be changed here. Switching filter_type to dropdown requires dropdown_options.

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID
board_idstringRequiredformat: "uuid"
filter_idstringRequiredformat: "uuid"

Headers

X-API-KeystringRequired
Your workspace API key.

Request

This endpoint expects an object.
display_labelstring or nullOptional1-80 characters
New label
filter_typeenum or nullOptional
New declared value type
default_valuestring or nullOptional

New default; send null to require an explicit value

dropdown_optionslist of objects or nullOptional

Replacement options. Required when changing filter_type to dropdown.

Response

Successful Response
filter_idstringformat: "uuid"
Identifier of the updated filter

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error