Delete a Quiz

Permanently remove a quiz from a namespace.

---

Overview

This endpoint allows you to delete a specific quiz and all associated data. This operation cannot be undone.

Method: DELETE
Endpoint:
/api/v1/namespaces/:namespaceId/quizzes/:quizId

Requires administrative authentication.

---

Request

Headers

x-api-key: {your_api_key}  # Required

Path Parameters

Parameter	Type	Required	Description
namespaceId	string	✅	Namespace unique ID
quizId	string	✅	Quiz unique ID

No request body is required for this operation.

---

Response

{
  "quiz": {
    "id": "hK5ZY9n6xaUF5Mu3hnwV",
    "name": "Updated Quiz Name",
    "primaryColor": "#6633ff",
    "customCTA": {
      "ctaLink": "https://example.com/learn-more",
      "ctaTitle": "Learn More About Financial Health",
      "ctaButton": "Explore Resources",
      "ctaDescription": "Discover tools and tips to improve your financial well-being"
    },
    "customCTAs": {},
    "customRecommendationCard": {},
    "customIntroScreen": {
      "headerMessage": "Welcome to Our Survey",
      "mainMessage": "Help us improve your experience",
      "buttonMessage": "Begin Survey",
      "customLogoUrl": "https://storage.googleapis.com/fhc-dev-files/https://example.com/logo.png"
    },
    "hasCustomIntro": true,
    "customOutroScreen": {},
    "createdOn": 1752737950897,
    "start": 1758637199999,
    "end": 1759637199999,
    "questions": [...],
    "anonymous": true,
    "inapp": false,
    "fhscore": false,
    "status": "queued",
    "disableEmailing": true,
    "emailedOn": null,
    "wasReminded": false,
    "lastDfUpdate": {
      "_seconds": 1752737950,
      "_nanoseconds": 897000000
    }
  }
}

The response includes the details of the quiz that was deleted.

---

Notes

• Associated answer data will not be removed when a quiz is deleted, answer data is deleted independently
• This action is permanent and cannot be undone
• This operation is logged for audit purposes