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
Path parameters
subdomainstringRequired
userIdstring · uuidRequired
Header parameters
x-api-keystringRequired
Body
xpnumberRequired
labelstringRequired
descriptionstringOptional
Responses
200
200
application/json
post
POST /public/communities/{subdomain}/users/{userId}/xp HTTP/1.1
Host: api-v2.zealy.io
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "xp": 1,
  "label": "text",
  "description": "text"
}
{
  "xp": 1,
  "label": "text",
  "description": "text",
  "communityId": "text",
  "receiverId": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "id": "text",
  "deleted": true
}

Remove XP from a specific user

delete
Path parameters
subdomainstringRequired
userIdstring · uuidRequired
Header parameters
x-api-keystringRequired
Body
xpnumberRequired
labelstringRequired
descriptionstringOptional
Responses
200
200
application/json
delete
DELETE /public/communities/{subdomain}/users/{userId}/xp HTTP/1.1
Host: api-v2.zealy.io
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "xp": 1,
  "label": "text",
  "description": "text"
}
{
  "xp": 1,
  "label": "text",
  "description": "text",
  "communityId": "text",
  "receiverId": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "id": "text",
  "deleted": true
}
PreviousUser lookupNextBan user

Last updated

Was this helpful?