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 |
|---|
| credentials (required) | credentials | Read the description of the Credentials object. |
| userId (required) | string | The ID of the user whom you want to activate or deactivate. |
| status (required) | string | Specify user status: 1 — active 3 — inactive |
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 profile 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. |
| User status must be 1 or 3, <status> given | An unacceptable status. |
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>
<ChangeUserStatusRequest>
<credentials>
<accountUrl>https://myaccount.ispringlearn.com</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<userId>string</userId>
<status>1</status>
</changeUserStatusRequest>
</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