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": "Respondents deleted successfully",
  "results": {
    "deleted": {
      "respondent": 2
    }
  }
}
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 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.