academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Exams [Beta] → Enrol participants to an exam.

AI-generated

Summary

Enrolls participants in the specified exam by sending booking references to the academyFIVE API.

Inputs

  • examId (required) — The exam ID used in the enrolment request path.
  • data.type (required) — The type value for the enrolment data object.
  • data.relationships.bookings.data (required) — One or more booking records to enrol. Each record requires a type and the booking ID in id.

Output shape

A list of items containing the API's JSON response.

The node makes an authenticated POST request to /api/v1/exams/{examId}/enrolment. The booking data collection supports multiple entries. If Continue On Fail is enabled, request or parameter errors are returned as an item with an error field.

Links

Discussion