AVAILABLE WITH BUSINESS SUBSCRIPTION
Request: POST /gamification/points/award
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, Publishers, or custom roles.
Department Administrators, and users with a custom role can award only users belonging to departments they manage and their sub-departments.
Parameter | Description |
|---|
| X-Auth-Account-Url (required) | The base URL of the account, e.g. https://myaccount.ispringlearn.com |
| X-Auth-Email (required) | The login of Account Owner, Account Administrator, Department Administrator, or a user with a custom role able to edit users. |
| X-Auth-Password (required) | The password of Account Owner, Account Administrator, Department Administrator, or a user with a custom role able to edit users. |
| user_id (required) | The ID of the user whom you want to award with points. |
| amount (required) | The amount of points to be awarded. |
| reason (required) | The reason for awarding the points. |
Response Codes
Code | Text | Description |
|---|
| 200 | OK | The points have been successfully awarded. |
| 400 | Bad Request | A request error. |
| 401 | Unauthorized | An authorization error. |
| 403 | Permission denied | The user doesn't have enough permissions to fulfill the request. |
Sample Request
POST /gamification/points/award https/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"?>
<awardGamificationPoints>
<userId>3fa85f64-5717-4562-b3fc-2c963f66afa6</userId>
<amount>10</amount>
<reason>string</reason>
</awardGamificationPoints>
XML
Sample Response