Zealy API
  • Introduction
  • Authentication
  • Use cases
  • Rate limits
  • Pagination
  • FAQ
  • API Reference
    • Communities
      • Community lookup
      • Community member check
      • Community Secret Retrieval
      • Community Secret Creation
    • Users
      • User lookup
      • Add & Remove XP
      • Ban user
      • Referral code
      • Delete Zealy Connect for member
    • Leaderboards
      • Retrieve a leaderboard
      • List sprints
    • Reviews
      • Claimed quests lookup
      • Review a submission
      • Review events
    • Modules
    • Quests
      • Create quest
      • Update quest
      • List quests
    • Webhooks
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. Users

Add & Remove XP

PreviousUser lookupNextBan user

Last updated 7 months ago

Was this helpful?

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

  • Overview
  • API Reference
  • POSTGive XP to a specific user
  • DELETERemove XP from a specific user

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
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
409
409
application/json
429
429
application/json
500
500
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
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
409
409
application/json
429
429
application/json
500
500
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
}