Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, Publishers, or custom roles.
Department Administrators, Publishers, and users with a custom role can edit enrollments assigned to the users from the departments they manage and their sub-departments.
|credentials (required)||credentials||Read the description of the Credentials object.|
The ID of the enrollment you want to edit. You can obtain an enrollment ID with the Getting a List of Enrollments method.
|accessDate (required)||dateTime||The date when learners are supposed to start studying the course. If the start date isn't indicated, the current date will be auto-populated.|
|dueDateType (required)||string||This parameter indicates if the course has a due date or it isn't time-limited. Possible values of the parameter are unlimited, default, due_date, due_period.|
|dueDate (required)||date||This parameter is required if dueDateType is equal to due_date.|
|duePeriod (required)||int||This parameter is required if dueDateType is equal to due_period. It is measured in hours.|
|lockAfterDueDate (required)||bool||This parameter is required if dueDateType is equal to due_date/due_period. It indicated if the access to the course will remain open when the due date expires or will be locked.|
After the request has been successfully processed, the system returns an object with the following properties:
|success||bool||True if the enrollment has been successfully edited.|
|Unknown Enrollment||The enrollment wasn't found.|
The user has no permissions to edit enrollments.
|Wrong Parameters||The system failed to process the request because it did not contain all necessary parameters.|