Method: unenroll

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 users from the departments they manage and their sub-departments.

Parameters

Parameter	Type	Description
credentials (required)	credentials	Read the description of the Credentials object.
enrollmentId (required)	string	The ID of the enrollment you want us to delete.

Return Value

After the request has been successfully processed, the system returns an object with the following properties:

Parameter	Type	Description
success	bool	True if the enrollment has been deleted.

Possible Errors

Error	Description
Permission denied	The user has no permissions to delete enrollments.
Wrong parameters	The enrollment with the given ID hasn't been found.

Sample Request

 <?xml version="1.0" encoding="utf-8"?>
 <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                    xmlns="https://ispringlearn.com/go/services/api/soap">
   <SOAP-ENV:Body>
     <UnenrollRequest>
       <credentials>
         <accountUrl>https://myaccount.ispringlearn.com</accountUrl>
         <email>email@email.com</email>
         <password>password</password>
       </credentials>
       <enrollmentId>string</enrollmentId>
     </UnenrollRequest>
   </SOAP-ENV:Body>
 </SOAP-ENV:Envelope>

XML

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="https://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <successResult>
      <success>true</success>
    </successResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

XML