Skip to main content
POST
/
v3
/
stopSurvey
Stop a survey
curl --request POST \
  --url https://api.redem.io/v3/stopSurvey \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "surveyName": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "results": {
    "surveyId": "<string>",
    "surveyName": "<string>",
    "status": "<string>"
  }
}
A stopped survey no longer accepts new respondents, preventing any further additions.

Authorizations

api-key
string
header
required

Body

application/json
surveyName
string
required

The name of the survey to stop.

Response

Survey stopped successfully

success
boolean
message
string
results
object