Skip to main content
POST
/
v3
/
deleteRespondents
Delete respondents
curl --request POST \
  --url https://api.redem.io/v3/deleteRespondents \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "surveyName": "<string>",
  "respondentIds": [
    "<string>"
  ]
}'
{
  "success": true,
  "message": "<string>",
  "results": {}
}
Delete one or more respondents from a survey. Also removes related metadata, interaction data, and flattened records. If no respondents remain for the survey, the survey is deleted automatically.

Authorizations

​
api-key
string
header
required

Body

application/json
​
surveyName
string
required

The name of the survey.

​
respondentIds
string[]
required

Array of respondent IDs to delete.

Minimum length: 1

Response

Respondents deleted successfully

​
success
boolean
​
message
string
​
results
object