Page tree
Skip to end of metadata
Go to start of metadata

Deduct points from users and specify the reason for the withdrawal with a POST request to the following URL: /gamification/points/withdraw.

Permissions to run the request: Account Owner, Account Administrators, Department Administratorsor users with a custom role able to edit users.

Department Administrators and users with a custom role can deduct points only from users belonging to departments they manage and their sub-departments.

Request Headers

Parameter

Description

X-Auth-Account-Url (required)The base URL of the account, e.g. http://myaccount.ispringlearn.com
X-Auth-Email (required)The login of Account Owner, Account AdministratorDepartment Administrator, or a user  with a custom role able to edit users.
X-Auth-Password (required)

The password of Account Owner, Account AdministratorDepartment Administrator, or a user with a custom role able to edit users.

user_id (required)The ID of the user whose points you want to deduct.
amount (required)The amount of points to be deducted.
reason (required)The reason for deducting the points.

Response Codes

Code

Text

Description

200Successful operationThe points are successfully deducted.
400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission deniedThe user doesn't have enough permissions to fulfill the request.

Sample Request

POST /gamification/points/withdraw HTTP/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: https://myaccount.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password
Content-Type: application/xml
Accept: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<withdrawGamificationPoints>
<userId>2c180ffc-8841-11e9-b68a-0242c0a85016</userId>
<amount>10</amount>
<reason>string</reason>
</withdrawGamificationPoints>

Sample Response

HTTP/1.1 200 Successful operation
Connection: close
  • No labels