AVAILABLE WITH BUSINESS SUBSCRIPTION

Request: POST /users/deactivate

Permissions to Run the Request

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

Department Administrators and users with a custom role may activate or 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
userIds (required)The ID users you want to deactivate.

Possible Response Codes

Code

Text

Description

200OKA user's status is changed.
400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission DeniedThe user doesn't have enough permissions to activate or deactivate users. For example, Department Administrators can't activate or deactivate users who don't belong to the departments they manage.

Sample Request

Host: api-learn.ispringlearn.com 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE 
Content-Type:application/xml

<request>
    <userIds>f5bafbba-c7eb-11ed-a327-0242ac12004e</userIds>
    <userIds> 76a38028-c8b7-11ed-a616-0242ac15004f</userIds>
</request>
XML

Sample Response

https/1.1 200 OK
XML