Add & Remove XP
Overview
Those two endpoints allow you to add/remove XP from a user. The XP added and removed will appear in the user notifications and activity.
The XP given from the API will count both for the all time and sprint leaderboard if any,
API Reference
Give XP to a specific user
POST https://api-v1.zealy.io/communities/:subdomain/users/:userId/xp
Path Parameters
| Name | Type | Description |
|---|---|---|
subdomain* | String | Subdomain of your community |
userId* | String | ID of the user to give XP to |
Headers
| Name | Type | Description |
|---|---|---|
x-api-key* | String | Your API key |
Request Body
| Name | Type | Description |
|---|---|---|
label* | String | Label that will appear on the Crew3 user activity |
xp* | Number | Number of XP to give |
description | String | Additional information |
Remove XP from a specific user
DELETE https://api-v1.zealy.io/communities/:subdomain/users/:userId/xp
Path Parameters
| Name | Type | Description |
|---|---|---|
subdomain* | String | Subdomain of your community |
userId* | String | Id of the user to remove XP from |
Headers
| Name | Type | Description |
|---|---|---|
x-api-key* | String | Your API key |
Request Body
| Name | Type | Description |
|---|---|---|
label* | String | Label that will appear on the Crew3 user activity |
xp* | Number | Number of XP to remove |
description | String | Additional information |
Last updated