AVAILABLE WITH BUSINESS SUBSCRIPTION

Request: POST /user/{userId}/scheduled_deactivation

Permissions to Run the Request

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

Department Administrators and users with a custom role may automatically deactivate only users belonging to the departments they manage or their daughter departments. 

Request Headers

Header

Description

Authorization (required)Access token. You can obtain a token by making a request.
ParameterDescription
user_id (required)The ID of a user you want to deactivate on a specified date.
date (required)The date of automatic blocking in the yyyy-mm-dd format, for example, 2020-12-27.

Possible Response Codes

Code

Text

Description

200OKThe date of automatic blocking is set.
400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission DeniedThe user doesn't have enough permissions.

 

Sample Request

POST /user/43f4a84c-6280-11e9-8686-a6210366ac32/scheduled_deactivation https/1.1
Host: api-learn.ispringlearn.com 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE 
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8"?>
<request>
    <date>2020-12-27</date>
</request>
XML

Sample Response

https/1.1 200 OK
XML