Skip to main content
POST
/
businesses
/
{id}
/
filter_definitions
Create a filter definition
curl --request POST \
  --url https://api.pocketflows.com/businesses/{id}/filter_definitions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variable_name": "<string>",
  "label": "<string>",
  "options": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "id": "<string>",
  "label": "<string>",
  "variable_name": "<string>",
  "enabled": true,
  "options": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ]
}

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 business

Body

application/json
​
variable_name
string
required

The variable name of the filter definition

​
label
string
required

The label 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
​
options
The Filter Definition Option object · object[]
required

The options for the select dropdown

Response

200 - application/json

The created 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