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

​
surveyName
string
required

The name of the survey.

Response

Upon successful processing, 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.