Create or update an enrolment by your own foreign id

PUT/v1/enrolments/by-source-id/{sourceId}

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

Creates the enrolment if one doesn't yet exist for this source_id (same request body as POST /v1/enrolments), or updates the existing one if it does — lets your system track its own record id instead of having to store Florisage's uuid first. Pass status: "completed" to mark it complete: this fires enrolment.completed, and certificate.issued too if the course awards one. Marking complete only ever moves forward — it can't un-complete an already-finished enrolment.

curl -X PUT "https://florisage.com/api/v1/enrolments/by-source-id/hr-record-10482" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "jane.citizen@example.com",
  "first_name": "Jane",
  "last_name": "Citizen",
  "course_id": "c4a9e7d0-1b2f-4a6c-8d35-7f0e9b2a4c68",
  "status": "completed"
}'

200Enrolment updated

Path parameters

sourceIdstringpathrequired
Your own id for this enrolment (the source_id you chose).

Request bodyapplication/json

emailstring
first_namestring
last_namestring
course_idstring · uuid
statusstring
Allowed values:completed

Responses

200Enrolment updated
201Enrolment created