Create a filter

POST

https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/:directoryId/filters/

POST

/api/directory/private/v1alpha/directories/:directoryId/filters/

curl -X POST https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/directoryId/filters/ \
     -H "Authorization: Token  <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "id": "string",
  "type": "string",
  "name": "string",
  "slug": "string",
  "order": 1,
  "parentFilterId": "string",
  "parentFilterSlug": "string",
  "multipleSelectFromDashboard": true,
  "multipleSelectFromDirectory": true,
  "userAssignable": true,
  "displayInDirectory": true,
  "displayInInternalDirectory": true,
  "displayInEntryProfile": true,
  "displayInInternalEntryProfile": true,
  "displayInEntryProfileMainArea": true,
  "required": true,
  "overrides": {
    "attributes": [
      {
        "attribute": "string",
        "value": true
      }
    ],
    "conditions": [
      {
        "key": "string",
        "operator": "equals",
        "value": "string"
      }
    ]
  }
}'

{
  "name": "Filter 1",
  "order": 0,
  "assignmentDescription": "Assignment description",
  "multipleSelectFromDashboard": false,
  "multipleLimit": null,
  "multipleSelectFromDirectory": false,
  "displayInDirectory": true,
  "displayInInternalDirectory": false,
  "required": false,
  "filterOptions": [],
  "genericDirectory": "969d9b77-c063-4101-b534-63071317ddbd",
  "href": "/api/directory/private/v1alpha/filters/006059d7-4d1e-4ace-b816-32fa9a9659ac/",
  "id": "006059d7-4d1e-4ace-b816-32fa9a9659ac",
  "slug": "filter-1",
  "type": "user",
  "userEnabled": true
}

Create a filter within a directory

Authentication

AuthorizationToken

Your API key, sent as Authorization: Token <your API key>

Path parameters

directoryIdstringRequiredformat: "uuid"

ID of the directory containing the filter

Request

This endpoint expects an object.

idstringRequiredformat: "uuid"

typestringRequired>=1 character

namestringRequired1-150 characters

slugstringRequired>=1 character

orderintegerRequired>=0

parentFilterIdstringRequiredformat: "uuid"

parentFilterSlugstringRequired>=1 character

multipleSelectFromDashboardbooleanRequired

multipleSelectFromDirectorybooleanRequired

userAssignablebooleanRequired

displayInDirectorybooleanRequired

displayInInternalDirectorybooleanRequired

displayInEntryProfilebooleanRequired

displayInInternalEntryProfilebooleanRequired

displayInEntryProfileMainAreabooleanRequired

requiredbooleanRequired

overridesobject or nullRequired

Visibility rule of the filter, or null when it has none.

assignmentDescriptionstring or nullOptional<=150 characters

multipleLimitinteger or nullOptional1-250

isLocationbooleanOptionalDefaults to false

Whether this is one of the Country, Region and City filters, which visitors pick from as one Location filter.

Response

Details of the filter

namestring<=150 characters

orderintegerOptional>=0

assignmentDescriptionstring or nullOptional<=150 characters

multipleSelectFromDashboardbooleanOptional

multipleLimitinteger or nullOptional1-250

multipleSelectFromDirectorybooleanOptional

userAssignablebooleanOptional

displayInDirectorybooleanOptional

displayInInternalDirectorybooleanOptional

displayInEntryProfilebooleanOptional

displayInInternalEntryProfilebooleanOptional

displayInEntryProfileMainAreabooleanOptional

requiredbooleanOptional

overridesobject or nullOptional

A filter’s visibility rule, in the same shape as a form field’s overrides: when the conditions are met the filter takes the hidden value, otherwise the opposite one.

Errors

400

Bad Request Error