Flourish QMS

API reference / Enrolments

Enrol someone in a course

POST/v1/enrolments

Needs a bearer access token with the enrolments.write scope. How authentication works

Finds the learner by email, or creates a new Florisage account for them if none exists yet, links them to your organization, and consumes one of your purchased seats for the course. Fires an enrolment.created webhook once it's done. A brand-new learner is emailed a one-time code to set their own password — their account exists and the enrolment is active immediately, they just can't log in and start the course until they do that. Enrol someone in a course

Request bodyapplication/jsonrequired

  • emailstringrequired
  • first_namestring
  • last_namestring
  • course_idstring · uuidrequired
  • source_idstring

    Your own foreign id for this enrolment, for later lookup via /v1/enrolments/by-source-id.

Responses

  • 201Enrolment created
    Response fields
    • dataEnrolment
      • idstring · uuid
      • user_idstring · uuid
      • course_idstring · uuid
      • statusstring

        Allowed values:in_progresscompleted

      • enrolled_atstring · date-time
      • completed_atstring · date-timenullable
      • access_expires_atstring · date-timenullable
  • 400Invalid request (e.g. no seats available)
    Example response
    {
  "error": {
    "code": "invalid_request",
    "message": "Invalid request (e.g. no seats available)."
  }
}