Skip to main content
POST
Change cleaning settings
This endpoint applies cleaning settings to every respondent in a survey. Use it when you change your cleaning rules and want existing respondents to match them, without resubmitting each respondent.
  • Turn cleaning on (activateCleaning: true): stores cleaningSettings on each respondent and re-evaluates exclusion against the new thresholds.
  • Turn cleaning off (activateCleaning: false): removes the stored settings and clears exclusions for all respondents in the survey.
In both cases:
  • Scores are not recalculated. Only exclusion status and reasons change.
  • No credits are charged.
  • Any saved AI explanation on an affected respondent is cleared.
The same endpoint is also available at POST /v2/changeCleaningSettings. For the structure of cleaningSettings, see Add Respondent. The request uses the same thresholds and categories.

Authorizations

api-key
string
header
required

Body

application/json

Request body for changing cleaning settings.

surveyName
string
required

The survey name.

activateCleaning
boolean
required

true applies cleaningSettings and excludes respondents that fall below the thresholds. false turns cleaning off for all respondents and clears their exclusions.

cleaningSettings
object
required

Cleaning thresholds stored on every respondent in the survey. Unknown keys are rejected.

Response

When a request is successfully processed, the API returns a 200 OK status code along with the result.

success
boolean

Whether the operation succeeded.

message
string

Human-readable summary.

results
object