Method: scheduleUserTermination

Permissions to Run the Request

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

Department Administrators and users with a custom role may set up a scheduled end of employment only for users belonging to the departments they manage or their daughter departments.

Parameters

Parameter	Type	Description
token (required)	string	Access token. You can obtain a token by making a request.
userId (required)	string	The ID of a user you want to set up a scheduled end of employment for.
date (required)	date	The date when employment will end for a user in the yyyy-mm-dd format, for example, 2023-12-27.

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 automatic blocking date is set.

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 Call

<?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>
    <ScheduledUserTermination>
      <credentials>
         <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
      </credentials>
      <userId>string</userId>
      <date>2023-12-27</date>
    </ScheduledUserTermination>
  </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:ns1="https://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