XP — Archievery API

POST

/clans/{clanId}/members/{robloxId}/xp

Beta

Adds XP to a member. On an Auto Clan, crossing the first NORMAL rank's threshold creates the membership as a side effect.

Path parameters

Path parameters for POST /clans/{clanId}/members/{robloxId}/xp
Name	Type	Required	Description
`clanId`	string	required	The clan's identifier.
`robloxId`	string	required	The member's Roblox user ID.

Body

Request body fields for POST /clans/{clanId}/members/{robloxId}/xp
Name	Type	Required	Description
`amount`	integer	required	XP to add. May be negative to deduct.
`reason`	string	optional	Free text recorded alongside the change.
`source`	object	optional	Where the award came from. Nested to exercise the child-attribute renderer.
`placeId`	string	optional	The Roblox place that issued the award.
`matchId`	string	optional	Opaque round identifier.
`verified`	boolean	optional	Whether the issuing server passed attestation.

local HttpService = game:GetService("HttpService")

local response = HttpService:RequestAsync({
    Url = "https://api.example.invalid/v0/clans/CLAN_ID/members/ROBLOX_ID/xp",
    Method = "POST",
    Headers = {
        ["Authorization"] = "Bearer YOUR_CLAN_API_KEY",
        ["Content-Type"] = "application/json",
    },
    Body = HttpService:JSONEncode({
        amount = 150,
    }),
})

if response.Success then
    print(HttpService:JSONDecode(response.Body))
else
    warn(response.StatusCode, response.Body)
end

Updated member.

{
  "robloxId": "ROBLOX_ID",
  "xp": "4200",
  "rank": "Sergeant"
}

POST

/clans/{clanId}/xp

Deprecated

Superseded by the per-member endpoint. Still functional so existing game code keeps working.

Path parameters

Path parameters for POST /clans/{clanId}/xp
Name	Type	Required	Description
`clanId`	string	required	The clan's identifier.

Body

Request body fields for POST /clans/{clanId}/xp
Name	Type	Required	Description
`awards`	array of object	required	One entry per member.
`robloxId`	string	optional	Recipient's Roblox user ID.
`amount`	integer	optional	XP to add.

local HttpService = game:GetService("HttpService")

local response = HttpService:RequestAsync({
    Url = "https://api.example.invalid/v0/clans/CLAN_ID/xp",
    Method = "POST",
    Headers = {
        ["Authorization"] = "Bearer YOUR_CLAN_API_KEY",
        ["Content-Type"] = "application/json",
    },
    Body = HttpService:JSONEncode({
        awards = {
            {
                robloxId = "ROBLOX_ID",
                amount = 150,
            },
        },
    }),
})

if response.Success then
    print(HttpService:JSONDecode(response.Body))
else
    warn(response.StatusCode, response.Body)
end

Per-target results.

{
  "applied": 2,
  "results": []
}