Skip to main content
POST
Update a filter definition

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The ID of the filter definition

Body

application/json
variable_name
string

The updated variable name of the filter definition. Can be omitted

label
string

The updated label of the filter definition. Can be omitted

type
enum<string>

The updated type of the filter definition. Can be omitted

Available options:
select,
text,
number,
boolean,
date,
datetime,
currency,
array_of_known
options
The Filter Definition Option object · object[]

The updated options of the filter definition. Can be omitted. Will wholly replace the existing options

Response

200 - application/json

The updated FilterDefinition object

id
string
required

The ID of the filter definition

label
string
required

The label of the filter definition

variable_name
string
required

The variable name of the filter definition

type
enum<string>
required

The type of the filter definition

Available options:
select,
text,
number,
boolean,
datetime,
currency,
array_of_known
enabled
boolean
required

Whether the filter definition is enabled

options
The Filter Definition Option object · object[]

The options for the select dropdown