Attune Developer Hub

Appearance

Remove Question from a Quiz ​

Remove one or more questions from an existing quiz.

Overview ​

This endpoint allows you to remove questions from a quiz. Questions can only be removed from quizzes that have not yet started.

Method: POST
Endpoint:
/api/v1/namespaces/{namespaceId}/quizzes/{quizId}/questions/deleteQuestion

Requires administrative authentication.

Request ​

Headers ​

http
x-api-key: {your_api_key}  # Required
Content-Type: application/json

Path Parameters ​

ParameterTypeRequiredDescription
namespaceIdstring✅Namespace unique ID
quizIdstring✅Quiz unique ID

Body Parameters ​

The request body should be an array of strings, where each string is a question ID to remove. Each ID must be one of the predefined question types.

Example Request Body ​

json
["fin_health"]

For removing multiple questions:

json
["fin_health", "nps", "csat"]

Valid question IDs include: age, education, income, region, fin_health, nps, csat, emailNameZip, ethnicity, orientation, gender, trans, stress, ability, feel_managing, feel_money_situation, feel_effectiveness, feel_management_change, feel_debt, feel_control, stress_base, stress_cause, stress_effects, stress_confidence, institution_union, institution_needs, institution_primary, debt_type, and others specific to certain institutions.

Response ​

Success Response ​

Status Code: 200 OK

json
{
  "quiz": {
    "id": "c6fARMjW4E5l83umCovB",
    "name": "Employee Satisfaction Survey",
    "primaryColor": "#3366ff",
    "customCTA": {},
    "customCTAs": {},
    "customRecommendationCard": {},
    "customIntroScreen": {
      "customLogoUrl": null
    },
    "customOutroScreen": {},
    "createdOn": 1752737803343,
    "start": 1754006400000,
    "end": 1756684799000,
    "questions": [...],
    "anonymous": true,
    "inapp": false,
    "fhscore": false,
    "status": "queued",
    "disableEmailing": true,
    "emailedOn": null,
    "wasReminded": false,
    "lastDfUpdate": {
      "_seconds": 1752737803,
      "_nanoseconds": 343000000
    }
  }
}

The response includes the full quiz object with the specified question(s) removed.

Notes ​

  • Questions can only be removed from quizzes that have not yet started
  • The response includes the updated quiz object with the questions removed
  • If you attempt to remove a question that doesn't exist in the quiz, the operation may succeed without making any changes