Update Assessment Settings

put

https://api.testlify.com/v1/assessment/{id}/setting

Updates the configuration settings of an existing assessment, including proctoring, access restrictions, notifications, and the submission deadline.

Submission deadline supports three mutually exclusive modes:

Number of days from invite: set invitationEmailLinkValidity (> 0)
Fixed date/time: set assessmentDeadline + assessmentDeadlineTz
Never expire: send invitationEmailLinkValidity as 0 and omit assessmentDeadline

If both assessmentDeadline and invitationEmailLinkValidity are sent, assessmentDeadline takes precedence — server resets invitationEmailLinkValidity to 0.

This is a full replace (PUT) of the settings object, not a partial patch — any field omitted from the request is reset to its default (or null), not left unchanged. Send the complete settings payload every time.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Assessment ID (24-character MongoDB ObjectId)

Body Params

Assessment settings configuration

invitationEmailLinkValidity

number

Defaults to 30

Submission deadline — 'Number of days' mode. Number of days from candidate invite until the link expires. Send 0 for 'Never expire'. Ignored/reset to 0 if assessmentDeadline is also set.

assessmentDeadline

date-time | null

Submission deadline — 'Date and time' mode. Fixed expiry timestamp. Requires assessmentDeadlineTz to be a valid IANA timezone. Setting this forces invitationEmailLinkValidity to 0 server-side.

assessmentDeadlineTz

string

IANA timezone for assessmentDeadline. Required when assessmentDeadline is set.

assessmentStartTime

date-time | null

Fixed date/time the assessment becomes accessible to candidates. Requires assessmentStartTimeTz. Mutually exclusive with assessmentStartDays.

assessmentStartTimeTz

string

IANA timezone for assessmentStartTime.

assessmentStartDays

number | null

Number of days after invite before the assessment becomes accessible. Must be greater than 0. Cleared automatically if assessmentStartTime is set.

assessmentEndTime

date-time | null

Fixed date/time the assessment window closes.

shareableLinkExpiry

date-time | null

Expiry timestamp for the assessment's public shareable link. Requires shareableLinkExpiryTz to be a valid IANA timezone. Must be a future date.

shareableLinkExpiryTz

string

IANA timezone for shareableLinkExpiry.

attemptTestLibrariesRequired

boolean

Whether attempting all test libraries is required

webcamAndMicrophoneAccessRequired

boolean

Whether webcam and microphone access is required

skipRegistration

boolean

Whether to skip the candidate registration process

candidateAccommodation

boolean

Whether candidate accommodation is enabled

allowReadAloud

boolean

Defaults to true

Whether read-aloud accessibility is allowed

enableAudibleTimeAlerts

boolean

Defaults to true

Whether audible time alerts are enabled

enableSystemCompatibilityCheck

boolean

Defaults to false

Whether the pre-assessment system compatibility check is enabled

locationAccess

boolean

Whether location access is required

enableGrammarly

boolean

Whether Grammarly is enabled during the assessment

disableFullScreen

boolean

Whether to disable the forced full-screen requirement

screenShare

boolean

Defaults to false

Whether screen sharing is enabled

snapshotCaptureRequired

boolean

Whether periodic webcam snapshot capture is required

snapshotIntervalType

string

Defaults to DEFAULT_SNAPSHOT_INTERVAL

Snapshot interval mode

customSnapshotInterval

number

Defaults to 120

Custom snapshot interval in seconds (used when snapshotIntervalType is CUSTOM_SNAPSHOT_INTERVAL)

dualCameraProctoring

boolean

Defaults to false

Whether dual-camera proctoring is enabled

ipProctoringEnabled

boolean

Whether IP-based proctoring is enabled

defaultLanguage

string

Default language for the assessment

sendAssessmentResultEmail

boolean

Whether to send the assessment result email to the candidate

notSendAcknowledgement

boolean

Defaults to false

Whether to suppress the acknowledgement email. Defaults to the organization's isSendEmailAcknowledgement setting if omitted.

recurringScore

boolean

Defaults to false

Whether recurring score recalculation is enabled

enableNavigationToPreviousQuestions

boolean

Whether candidates can navigate back to previous questions

enableAccessibility

boolean

Defaults to false

Whether accessibility mode is enabled

allowNegativeScorePercentageForAssessment

boolean

Defaults to false

Whether negative scoring is allowed for this assessment

talkingProhibition

boolean

Whether talking is flagged/prohibited during the assessment

logGenerationRequired

boolean

Defaults to false

Whether detailed activity log generation is required

recipientForNotification

array of strings

Email addresses notified on assessment activity

recipientForNotification

restrictedDomains

array of strings

Defaults to []

Domains affected by restrictionType

restrictedDomains

restrictionType

string

enum

Defaults to NONE

How restrictedDomains is applied: ALLOWED (allow-list), DISALLOWED (block-list), or NONE

Allowed:

randomizeCustomQuestion

boolean

Defaults to false

Whether custom question order is randomized per candidate

randomizeCustomOptions

boolean

Defaults to false

Whether custom question option order is randomized per candidate

redirectSettings

object

Post-completion redirect configuration

referenceSettings

object

Reference-check submission settings (see reference settings model for full shape)

Responses

204

Assessment settings updated successfully (no content returned)

400Bad Request

401Unauthorized

500Internal Server Error