modl.gg

Create Player Note

Add a note to a player's record.

POST /v1/minecraft/players/{uuid}/notes

Add a staff note to a player's record. Notes are stored permanently and visible to all staff members with access to the player's profile.

Authentication

Requires the X-API-Key header with your server's API key.

X-API-Key: your-api-key-here

Request

Headers

HeaderTypeRequiredDescription
X-API-KeystringYesYour server's API key.
Content-TypestringYesMust be application/json.

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesThe player's Minecraft UUID.

Body

FieldTypeRequiredDescription
textstringYesThe note content. Must not be blank.
issuerNamestringYesThe name of the staff member creating the note. Must not be blank.
{
  "text": "Player was warned verbally about chat behavior",
  "issuerName": "StaffMember"
}

Response

200 OK

{
  "status": 200,
  "success": true,
  "message": "Note added"
}

Error Responses

Status CodeDescription
400Invalid request body. text and issuerName must not be blank.
401Missing or invalid API key.
404Player not found for the given UUID.
429Rate limit exceeded.
500Internal server error.

On this page