Skip to main content
PATCH
Update test takers

Authorizations

x-api-key
string
header
required

API key generated in the Portal (Workspace Settings → API Keys).

Path Parameters

projectId
string<uuid>
required

Project Id. Obtain via GET /projects or from the project URL.

Body

id
referenceId
null | string
Maximum string length: 500
firstName
null | string
Maximum string length: 100
lastName
null | string
Maximum string length: 100

Response

OK

id
required

Numeric identifier of the test taker within the project.

email
string
required

The test taker's email address.

referenceId
null | string

Your own identifier for this test taker, echoed back if one was supplied on creation. Null if none was set.

firstName
null | string

The test taker's first name. Null if not provided.

lastName
null | string

The test taker's last name. Null if not provided.

fullName
string

The test taker's full name (first and last combined). Empty string if no name is on file.

yearOfBirth

The test taker's year of birth. Null if not provided.

result
null | enum<string>

Latest assessment status for this test taker. Null if they have not started a test yet.

Available options:
Started,
Completed,
CouldNotCompleteConnectionIssues,
CouldNotCompleteNpServerIssues,
CouldNotCompleteTimedOut,
CouldNotCompleteUnsupportedDevice,
Confirming,
HighRisk,
InProgress,
NotStarted,
Incomplete,
Fatigued,
Distressed,
ReasonableCause,
Escalated,
Emergency,
null
Example:

"Started"

dateCompleted
null | string<date-time>

When the test taker's most recent assessment was completed (ISO-8601, UTC). Null if no assessment has been completed.

lastTestSentUtc
null | string<date-time>

When the most recent test invitation was sent to this test taker (ISO-8601, UTC). Null if a test has never been sent.

topPerformer
boolean

Whether this test taker is flagged as a top performer for the project. A derived categorical indicator, not a score or ranking.