AVAILABLE WITH BUSINESS SUBSCRIPTION
Request: POST /enrollment/delete
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 delete enrollments assigned to learners belonging to the departments they manage and their sub-departments.
X-Auth-Account-Url (required) | The base URL of the account, e.g. https://myaccount.ispringlearn.com. |
| X-Auth-Email (required) | The login of Account Owner, Administrator, Department Administrator, Publisher, or a user with a custom role. |
| X-Auth-Password (required) | The password of Account Owner, Administrator, Department Administrator, Publisher or a user with a custom role. |
| Parameter | Description |
|---|
enrollmentIds | The IDs of the enrollments you want to delete. |
Header | Description |
|---|
Response Codes
| Code | Text | Description |
|---|
| 204 | No Content | The enrollment has been successfully deleted. |
| 400 | Bad Request | A request error. |
| 401 | Unauthorized | An authorization error. |
| 403 | Permission denied | The user doesn't have enough permissions to delete enrollments. |
Sample Request
POST /enrollment/delete https/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: https://myaccount.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password
Content-Type:application/xml
<?xml version="1.0" encoding="UTF-8"?>
<DeleteEnrollments>
<enrollmentIds>
<id>c4f74ae0-e029-11e9-ba51-0a580af4b0f</id>
</enrollmentIds>
</DeleteEnrollments>
XML
Sample Response
https/1.1 204 No Content
XML