PRprolific
filterSets

Create filter set

Changed on

Create a filter set from a list of filters

post/api/v1/filter-sets/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/filter-sets/
  • Auth
    API key in header Authorization

Request body

workspace_idstring

ID of the workspace where the filter set can be used.

organisation_idstring

ID of the organisation where the filter set can be used.

namestring

Name of the filter set.

descriptionstring nullable

Description of the filter set.

Response

Filter set created

idstring

ID of the filter set.

versioninteger

An incrementing integer indicating the version of the filter set.

is_deletedboolean

Whether the filter set has been deleted.

is_lockedboolean

Whether the filter set has been locked.

workspace_idstring nullable

ID of the workspace where the filter set can be used.

organisation_idstring nullable

ID of the workspace where the filter set can be used.

namestring

Name of the filter set.

descriptionstring nullable

Description of the filter set.

eligible_participant_countinteger

The number of participants who match the filter sets filters. Please note that if the number is lower than 5 the count will be obscured to prevent identification of participants.

Changes

  • 9cabd62d103fRevision changes
    • info

      added the new optional request property ///

    • info

      added the new optional request property //////

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ////// to the response with the status

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API