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.

Request Headers

Authorization (required)Access token. You can obtain a token by making a request.
ParameterDescription

enrollmentIds

The IDs of the enrollments you want to delete.

Header

Description

Response Codes

CodeTextDescription
204No ContentThe enrollment has been successfully deleted.
400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission deniedThe user doesn't have enough permissions to delete enrollments.

Sample Request

POST /enrollment/delete https/1.1
Host: api-learn.ispringlearn.com
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE 
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