Method: deactivateUsers

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, or custom roles.

Department Administrators and users with a custom role can activate and deactivate the users belonging to the departments they manage and their sub-departments.

Parameters

Parameter	Type	Description
token (required)	string	Access token. You can obtain a token by making a request.
userIds (required)	string	The ID of the users whom you want to deactivate.

Return Value

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

Parameter	Type	Description
success	bool	true if the user's status has been updated.

Possible Errors

Type	Description
Unknown user	A user with the specified ID was not found.
Permission denied	A user does not have enough permissions to handle the operation.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.com/go/services/api/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:DeactivateUsersRequest>
         <soap:credentials>
             <soap:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</soap:token>
         </soap:credentials>
         <soap:userIds>
            <!--Zero or more repetitions:-->
 			 <soap:id>32bd7dc6-a7cb-11ed-b640-92a80c30e0de</soap:id>
			 <soap:id>887c4dfc-4806-11ed-aa3d-dec5838cbd40</soap:id>
         </soap:userIds>
      </soap:DeactivateUsersRequest>
   </soapenv:Body>
</soapenv:Envelope>

XML

Sample Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://ispringlearn.com/go/services/api/soap">
   <SOAP-ENV:Body>
      <ns1:SuccessResult>
         <ns1:success>true</ns1:success>
      </ns1:SuccessResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

XML