Skip to main content
Every request on this page requires a Bearer API key.

Participant endpoints

Parameters

Example request

Example response

Participants created through the API are verified straight away. The email is stored in lowercase. If a participant with the same email was previously deleted from the project, that account is restored and updated with the data you send.

Parameters

Example request

Example response

Status 201.
Participants are matched by email. The format of every row is validated first: a single invalid row rejects the whole request with status 422, and the error key points to that row (for example participants.3.email). Once validation passes, each row is processed separately and the outcome is reported per row:
  • created — a new participant was created, or a previously deleted participant was restored.
  • updated — the participant already exists and update_existing is true.
  • skipped — the participant already exists and update_existing is false. The item includes a reason.
  • failed — the row could not be processed. The item includes a reason and no participant_id.
With update_existing: true, an existing participant’s data is replaced with the row’s contents: name, password and label. The label is removed if label_id is not sent, and an inactive participant is reactivated.

Parameters

Example request

Example response

Parameters

Example request

Example response

This endpoint also accepts the PUT method.

Parameters

Fields you don’t send are left unchanged. The email cannot be changed through the API. A participant with is_active: false cannot sign in to the CBT, including through an exam access link.

Example request

Example response

A participant who is still registered for an exam cannot be deleted; the request is rejected with status 409. Cancel their exam registration first with DELETE /exams/{exam}/participants/{participant}.

Parameters

Example request

Example response

Sorted from the most recent registration. results contains one item for each test in the exam, with the same structure as in the Exam Results API.

Parameters

Example request

Example response

Parameters

Example request

Example response

Parameters

Example request

Example response