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

POSThttps://api-v2.zealy.io/public/communities/{subdomain}/users/{userId}/xp

Path parameters

subdomain*string

userId*string (uuid)

Header parameters

Body

application/json

Body

xp*number

label*string

descriptionstring

Response

200400401403404409429500

200

Body

application/json

xp*number

label*string

description*nullable string

communityId*string

receiverId*string

createdAt*nullable string

updatedAt*nullable string

id*string

deleted*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://api-v2.zealy.io/public/communities/{subdomain}/users/{userId}/xp', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "xp": 0,
      "label": "text"
    }),
});
const data = await response.json();

Response

200400401403404409429500

{
  "xp": 0,
  "label": "text",
  "description": "text",
  "communityId": "text",
  "receiverId": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "id": "text",
  "deleted": false
}

Remove XP from a specific user

DELETEhttps://api-v2.zealy.io/public/communities/{subdomain}/users/{userId}/xp

Path parameters

subdomain*string

userId*string (uuid)

Header parameters

Body

application/json

Body

xp*number

label*string

descriptionstring

Response

200400401403404409429500

200

Body

application/json

xp*number

label*string

description*nullable string

communityId*string

receiverId*string

createdAt*nullable string

updatedAt*nullable string

id*string

deleted*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://api-v2.zealy.io/public/communities/{subdomain}/users/{userId}/xp', {
    method: 'DELETE',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "xp": 0,
      "label": "text"
    }),
});
const data = await response.json();

Response

200400401403404409429500

{
  "xp": 0,
  "label": "text",
  "description": "text",
  "communityId": "text",
  "receiverId": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "id": "text",
  "deleted": false
}