Set rank - Lumonol Documentation

Set rank

curl --request PATCH \
  --url https://api.lumonol.co.uk/ankra/set-rank \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "roblox_user_id": 123
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({roblox_user_id: 123})
};

fetch('https://api.lumonol.co.uk/ankra/set-rank', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.lumonol.co.uk/ankra/set-rank"

payload = { "roblox_user_id": 123 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "success": true
}

{
  "error": "roblox_user_id is required"
}

{
  "error": "roblox_user_id is required"
}

{
  "error": "roblox_user_id is required"
}

{
  "error": "roblox_user_id is required"
}

PATCH

/

set-rank

Set rank

curl --request PATCH \
  --url https://api.lumonol.co.uk/ankra/set-rank \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "roblox_user_id": 123
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({roblox_user_id: 123})
};

fetch('https://api.lumonol.co.uk/ankra/set-rank', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.lumonol.co.uk/ankra/set-rank"

payload = { "roblox_user_id": 123 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "success": true
}

{
  "error": "roblox_user_id is required"
}

{
  "error": "roblox_user_id is required"
}

{
  "error": "roblox_user_id is required"
}

{
  "error": "roblox_user_id is required"
}

Authorizations

Authorization

string

header

required

A workspace API key from Settings › Developer.

Query Parameters

workspace_id

string

required

The workspace: the 24-character ID in its Ankra address, or its UUID.

Body

application/json

roblox_user_id

integer

required

The Roblox user ID of the person.

role_id

string

The Roblox role ID to rank them to.

rank

integer

The rank number to rank them to, looked up in the group's roles.

Required range: 1 <= x <= 255

executor_roblox_user_id

integer

Roblox user ID of whoever did this in game. Recorded as the actor when they are linked to someone in the workspace.

Response

OK.

success

boolean