POST
/
v2
/
stopSurvey
Stop a survey
curl --request POST \
  --url https://api.redem.io/v2/stopSurvey \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "surveyName": "Global Vacation Insights 2024"
}'
{
  "success": true,
  "message": "Survey successfully stopped",
  "results": {
    "surveyName": "Global Vacation Insights 2024",
    "status": "STOPPED"
  }
}
A stopped survey no longer accepts new respondents, preventing any further additions.

Authorizations

​
api-key
string
header
required

Body

application/json

Request body for getting all respondents

Response

200
application/json

Upon successful processing, the API returns a 200 OK status code along with the expected data.

The response is of type object.