Update Test Settings

POST

/v3/tests/{testId}/settings

🛠️ Update test settings for given test.

Partial update is not supported. You need to first call “Get Test Settings” (unless already done), store the values or use them in your UI, then send the request with the entire settings object including your changed values.

⚠️ Certain settings follow internal rules — for example, enabling Allow Copy Paste disables the window violation popup. Please refer to app.interviewmocha UI to understand how these features work.

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://apiv3.imocha.io/v3/tests/{testId}/settings' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "testSettings": {
        "testName": "string",
        "testAliasName": "string",
        "typeOfTest": 0,
        "practiceTest": 0
    },
    "questionSettings": {
        "randomQuestions": 0,
        "randomAnswers": 0,
        "showQuestionScore": 0
    },
    "displayMessageSettings": {
        "sectionEndPopup": 0,
        "sectionTimeLeftAlert": 0,
        "candidateFeedback": 0
    },
    "emailSettings": {
        "sendTestReportEmailToCandidate": 0
    },
    "imageProctoringSettings": {
        "terminateTestOnImageViolation": 0,
        "terminateTestAfterViolationCount": 0
    },
    "windowViolationSettings": {
        "copyPaste": 0,
        "displayViolationSettings": {
            "displayViolationPopUp": 0,
            "terminateTestOnWindowViolation": 0,
            "terminateTestAfterViolationCount": 0
        }
    }
}'

Response Example

{
    "result": {
        "testSettings": {
            "testId": 1154360,
            "testName": "Junior Net Developer",
            "testAliasName": "Junior Net Developer",
            "typeOfTest": 1,
            "practiceTest": 1,
            "calculatorType": 0
        },
        "questionSettings": {
            "randomQuestions": 1,
            "randomAnswers": 1,
            "showQuestionScore": 1
        },
        "displayMessageSettings": {
            "sectionEndPopUp": 1,
            "sectionTimeLeftAlert": 1,
            "candidateFeedback": 1
        },
        "windowViolationSettings": {
            "copyPaste": 1,
            "displayViolationSettings": {
                "displayViolationPopUp": 1,
                "terminateTestOnWindowViolation": 1,
                "terminateTestAfterViolationCount": 1
            }
        },
        "imageProctoringSettings": {
            "terminateTestOnImageViolation": 1,
            "terminateTestAfterViolationCount": 1
        },
        "emailSettings": {
            "sendTestReportEmailToCandidate": 1
        }
    },
    "errors": null
}

Modified at 2025-08-19 13:31:41

Retrieve test settings

Callback notification