Skip to main content
POST
/
v2
/
updateRespondentsExcludedStatus
Update respondents excluded status
curl --request POST \
  --url https://api.redem.io/v2/updateRespondentsExcludedStatus \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "surveyName": "Customer-Satisfaction-2025",
  "respondentIds": [
    "R123",
    "R124"
  ]
}
'
{ "success": true, "message": "Respondents excluded status updated successfully", "results": { "surveyName": "Customer-Satisfaction-2025", "respondentIds": [ "R123", "R124" ] } }

Documentation Index

Fetch the complete documentation index at: https://docs.redem.io/llms.txt

Use this file to discover all available pages before exploring further.

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

Request body for updating respondents excluded status

🔒 Authentication: This endpoint is only accessible via a PRIVATE API key type

​
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.