Skip to main content
POST
Update respondents excluded status
This endpoint allows you to manually update the exclusion status of one or more respondents within a survey. It acts as a toggle — if a respondent is currently excluded, they will be included after the update, and vice versa. The endpoint also automatically updates the reasonsForExclusion field to reflect the respondent’s new status.

Authorizations

api-key
string
header
required

Body

application/json
surveyName
string
required

The survey name.

respondentIds
string[]
required

Array of respondent IDs to update the excluded status.

Minimum array length: 1

Response

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

success
boolean

A variable indicating whether the operation was successful.

message
string

A variable that human-readable message providing additional context or confirmation of the requested action.

results
object

This object serves as a container to hold the results for the requested data, encapsulating all relevant information and outputs in a structured format.