Skip to main content
The enrollments endpoint lets you grant a student access to a specific course. You can call this endpoint multiple times for the same student and course, it is idempotent. If the student already has an enrollment record for that course (including a previously revoked one), the API sets their access status back to active rather than creating a duplicate record. Both the student and the course must exist in your academy, and the course must be published.

​
Enroll a student

POST /api/v1/students/:studentId/enrollments

​
Path parameters

​
studentId
string
required
UUID of the student to enroll. The student must already be a member of your academy, add them first using POST /api/v1/students if needed.

​
Body parameters

​
course_id
string
required
UUID of the course to enroll the student in. The course must belong to your academy and be published. Draft courses return a 400 error.

​
Constraints

  • The student identified by studentId must be an active member of your academy. A 404 is returned if they are not found.
  • The course identified by course_id must exist in your academy and have a published status. A 404 is returned if it does not exist; a 400 is returned if it exists but is not published.

​
Response fields

Returns the enrollment record with a 201 status code.
​
data
object
required

​
Example request

curl -X POST \
  https://yourname.fayneos.com/api/v1/students/c3d4e5f6-a7b8-9012-cdef-123456789012/enrollments \
  -H "Authorization: Bearer fa_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "course_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }'

​
Example response

{
  "data": {
    "id": "e1f2a3b4-c5d6-7890-efab-123456789abc",
    "course_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "course_title": "Cold Outreach Mastery"
  }
}

​
Error responses

{
  "error": {
    "code": "not_found",
    "message": "Student not found in this academy"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Course not found"
  }
}

{
  "error": {
    "code": "invalid_course",
    "message": "Only published courses can be assigned"
  }
}

​
Revoke an enrollment

Removes a student’s access to a single course by revoking the enrollment. The enrollment record is kept but its access status is set to revoked, so the student loses access while the record is preserved. Re-enrolling later through POST /api/v1/students/:studentId/enrollments restores access on the same record. 
DELETE /api/v1/students/:studentId/enrollments/:enrollmentId

​
Path parameters

​
studentId
string
required
UUID of the student whose enrollment you are revoking.
​
enrollmentId
string
required
UUID of the enrollment record to revoke. This is the id returned when the enrollment was created.

​
Response fields

​
data
object
required

​
Example request

curl -X DELETE \
  https://yourname.fayneos.com/api/v1/students/c3d4e5f6-a7b8-9012-cdef-123456789012/enrollments/e1f2a3b4-c5d6-7890-efab-123456789abc \
  -H "Authorization: Bearer fa_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

​
Example response

{
  "data": {
    "revoked": true
  }
}

​
Error responses

{
  "error": {
    "code": "not_found",
    "message": "Enrollment not found"
  }
}