Bot API
Moderation
10 endpoints. Every address starts with https://api.samplebot.app/v1/servers/{server id}.
GET/cases moderation:read
Moderation cases, newest first. Filter by userId or kind.
| Name | In | Description |
|---|---|---|
userId | query | |
kind | query | warn, mute, kick, ban... |
limit | query |
curl "https://api.samplebot.app/v1/servers/{server id}/cases" \
-H "Authorization: Bearer $SAMPLE_API_KEY"GET/cases/:number moderation:read
One case, by its number.
| Name | In | Description |
|---|---|---|
number required | path |
curl "https://api.samplebot.app/v1/servers/{server id}/cases/{number}" \
-H "Authorization: Bearer $SAMPLE_API_KEY"GET/cases/users/:userId moderation:read
Someone's record: every case and a count by kind.
| Name | In | Description |
|---|---|---|
userId required | path |
curl "https://api.samplebot.app/v1/servers/{server id}/cases/users/{userId}" \
-H "Authorization: Bearer $SAMPLE_API_KEY"POST/cases/warn moderation:write
Warn a member. Logged and sent to them like a /warn.
| Name | In | Description |
|---|---|---|
userId required | body | |
reason required | body |
curl -X POST "https://api.samplebot.app/v1/servers/{server id}/cases/warn" \
-H "Authorization: Bearer $SAMPLE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"userId":"1246251869798400001","reason":"..."}'POST/cases/:number/void moderation:write
Void a case.
| Name | In | Description |
|---|---|---|
number required | path | |
reason | body |
curl -X POST "https://api.samplebot.app/v1/servers/{server id}/cases/{number}/void" \
-H "Authorization: Bearer $SAMPLE_API_KEY"GET/game-moderation moderation:read
In-game warnings, kicks, bans and BOLOs filed through Sample Bot.
| Name | In | Description |
|---|---|---|
player | query | Roblox username |
limit | query |
curl "https://api.samplebot.app/v1/servers/{server id}/game-moderation" \
-H "Authorization: Bearer $SAMPLE_API_KEY"POST/game-moderation moderation:write
File an in-game warning, kick, ban or BOLO. Kicks and bans run in the game.
| Name | In | Description |
|---|---|---|
action required | body | warn, kick, ban or bolo |
player required | body | |
reason required | body |
curl -X POST "https://api.samplebot.app/v1/servers/{server id}/game-moderation" \
-H "Authorization: Bearer $SAMPLE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"action":"...","player":"...","reason":"..."}'GET/game-moderation/bolos moderation:read
BOLOs waiting for a decision.
curl "https://api.samplebot.app/v1/servers/{server id}/game-moderation/bolos" \
-H "Authorization: Bearer $SAMPLE_API_KEY"POST/game-moderation/bolos/:id/approve moderation:write
Approve a BOLO, which bans the player in game.
| Name | In | Description |
|---|---|---|
id required | path |
curl -X POST "https://api.samplebot.app/v1/servers/{server id}/game-moderation/bolos/{id}/approve" \
-H "Authorization: Bearer $SAMPLE_API_KEY"POST/game-moderation/bolos/:id/decline moderation:write
Decline a BOLO.
| Name | In | Description |
|---|---|---|
id required | path | |
note | body |
curl -X POST "https://api.samplebot.app/v1/servers/{server id}/game-moderation/bolos/{id}/decline" \
-H "Authorization: Bearer $SAMPLE_API_KEY"