API ReferenceFilter Sets

Update filter set

View as MarkdownOpen in Claude
Update the details of a filter set.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

idstringRequired
ID of the filter set.

Request

This endpoint expects an object.
namestringOptional
Name of the filter set.
filterslist of objectsOptional
List of all filters contained in the filter set.

Response

Filter set updated
eligible_participant_countinteger or null
The number of participants who match the filter sets filters. Please note that if the number is lower than 25 the count will be obscured to prevent identification of participants.
filterslist of objects or null
List of all filters contained in the filter set.
idstring or null
ID of the filter set.
is_deletedboolean or null
Whether the filter set has been deleted.
is_lockedboolean or null
Whether the filter set has been locked.
namestring or null
Name of the filter set.
organisation_idstring or null
ID of the workspace where the filter set can be used.
versioninteger or null
An incrementing integer indicating the version of the filter set.
workspace_idstring or null
ID of the workspace where the filter set can be used.

Errors