PUT api/v1/learnerenrolments/{id}
Update learner enrolment record.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
id | Id of learner enrolment to update |
Define this parameter in the request URI. |
value | Learner enrolment data. Only learner personal details and enrolment custom fields can be updated. Enrolled course cannot be changed. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{ "enrolment_id": "sample string 1", "user_id": "sample string 2", "first_name": "sample string 3", "last_name": "sample string 4", "email": "sample string 5", "course_id": "sample string 6", "custom_enrolment_fields": [ { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" } ] }
Response Information
Updated learner enrolment record
Response body formats
application/json, text/json
Sample:
{ "data": { "enrolment_id": "sample string 1", "user_id": "sample string 2", "first_name": "sample string 3", "last_name": "sample string 4", "email": "sample string 5", "course_id": "sample string 6", "custom_enrolment_fields": [ { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" } ] }, "errors": { "messages": [ "sample string 1", "sample string 2", "sample string 3" ] } }