Skip to main content
PATCH
/
projects
/
{projectId}
/
testtakers
/
{id}
Update test taker
curl --request PATCH \
  --url https://api.neurapulse.com/projects/{projectId}/testtakers/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "id": 123,
  "referenceId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>"
}
'
{
  "id": 123,
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "fullName": "<string>",
  "yearOfBirth": 123,
  "referenceId": "<string>",
  "result": "Started",
  "dateCompleted": "2023-11-07T05:31:56Z"
}

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.

​
id
integer<int32>
required

The unique identifier of the test taker.

Body

​
id
integer<int32> | null
​
referenceId
string | null
Maximum string length: 500
​
firstName
string | null
Maximum string length: 100
​
lastName
string | null
Maximum string length: 100

Response

OK

​
id
integer<int32>
required
​
email
string
required
​
firstName
string
required
​
lastName
string
required
​
fullName
string
required
​
yearOfBirth
integer<int32>
required
​
referenceId
string | null
​
result
any | null
Available options:
Started,
Completed,
CouldNotCompleteConnectionIssues,
CouldNotCompleteNpServerIssues,
CouldNotCompleteTimedOut,
CouldNotCompleteUnsupportedDevice,
Confirming,
HighRisk,
InProgress,
NotStarted,
Incomplete,
​
dateCompleted
string<date-time>