Members — Archievery API

PATCH

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

Sets a member's rank directly. On a Linked clan the change is written to the Roblox group first and mirrored locally only once Roblox accepts.

Path parameters

Path parameters for PATCH /clans/{clanId}/members/{robloxId}
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 PATCH /clans/{clanId}/members/{robloxId}
Name	Type	Required	Description
`rankId`	string	required	Target rank. Must belong to this clan.

local HttpService = game:GetService("HttpService")

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

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

Updated member.

{
  "robloxId": "ROBLOX_ID",
  "rank": "Captain"
}

DELETE

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

Demotes the member to Guest. Does not delete their record.

Path parameters

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

local HttpService = game:GetService("HttpService")

local response = HttpService:RequestAsync({
    Url = "https://api.example.invalid/v0/clans/CLAN_ID/members/ROBLOX_ID",
    Method = "DELETE",
    Headers = {
        ["Authorization"] = "Bearer YOUR_CLAN_API_KEY",
    },
})

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

Removed.

No response body.