Update a filter

PATCH

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

PATCH

/api/directory/private/v1alpha/filters/:filterId/

curl -X PATCH https://v1.api.partnerpage.io/api/directory/private/v1alpha/filters/filterId/ \
     -H "Authorization: Token  <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "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
}

Update a filter

Authentication

AuthorizationToken

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

Path parameters

filterIdstringRequiredformat: "uuid"

ID of the filter to update

Request

This endpoint expects an object.

idstringOptionalformat: "uuid"

typestringOptional>=1 character

namestringOptional1-150 characters

slugstringOptional>=1 character

orderintegerOptional>=0

parentFilterIdstringOptionalformat: "uuid"

parentFilterSlugstringOptional>=1 character

assignmentDescriptionstring or nullOptional<=150 characters

multipleSelectFromDashboardbooleanOptional

multipleLimitinteger or nullOptional1-250

multipleSelectFromDirectorybooleanOptional

userAssignablebooleanOptional

displayInDirectorybooleanOptional

displayInInternalDirectorybooleanOptional

displayInEntryProfilebooleanOptional

displayInInternalEntryProfilebooleanOptional

displayInEntryProfileMainAreabooleanOptional

requiredbooleanOptional

isLocationbooleanOptionalDefaults to false

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

overridesobject or nullOptional

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

Response

Details of the filter

namestring<=150 characters