Abandon survey participation
DELETE
api/v1/user/{userkey}/surveys/{userSurveyId}
Description
Once abandoned, the survey can no longer be continued or submitted, but all existing data is retained for analytics and reporting purposes.
Usage Examples
Path Parameters
| Name | Type | Description |
|---|---|---|
userKey | string | Unique identifier of the user (derived from authentication context) |
id | UUID | Unique identifier of the user survey participation |
Status Transitions
| Current Status | Result |
|---|---|
NotStarted | Transitions directly to Abandoned |
InProgress | Preserves partial answers and transitions to Abandoned |
Completed | ❌ Not allowed (returns 400 Bad Request) |
Abandoned | No change (idempotent operation) |
Response
Data Preservation
Use Cases
Common Errors
| Error Code | Description |
|---|---|
USER_SURVEY_NOT_FOUND | Invalid survey ID or user does not have access |
CANNOT_ABANDON_COMPLETED_SURVEY | Survey participation has already been completed |
Request
Path Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request DELETE 'api/v1/user/{{user-key}}/surveys/'Response Response Example
{
"id": "string",
"surveyId": "string",
"userKey": "string",
"companyId": "string",
"status": 0,
"startedAt": "string",
"completedAt": "string",
"updatedDate": "string",
"createdDate": "string",
"surveyName": "string",
"surveyDescription": "string",
"surveyStartDate": "string",
"surveyEndDate": "string",
"totalQuestions": 0,
"answeredQuestions": 0,
"progressPercentage": 0,
"questions": [
{
"id": "string",
"surveyId": "string",
"questionType": 0,
"question": "string",
"orderQuestion": 0,
"choices": [
"string"
],
"createdDate": "string",
"updatedDate": "string",
"localizedQuestions": {
"ar": "string",
"en": "string"
},
"localizedChoices": {
"ar": [
"string"
],
"en": [
"string"
]
}
}
],
"answers": [
{
"id": "string",
"questionId": "string",
"question": "string",
"answer": "string",
"answeredAt": "string"
}
]
}Modified at 2025-12-23 20:48:24