modl.gg

Add Punishment Note

Add a note to an existing punishment record.

POST /v1/minecraft/punishments/{punishmentId}/note

Add an internal note to an existing punishment record. Notes are visible only to staff members and are useful for tracking additional context or follow-up information related to a punishment.

Authentication

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

Request

Headers

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

Path Parameters

ParameterTypeRequiredDescription
punishmentIdstringYesThe ID of the punishment to add a note to.

Body

FieldTypeRequiredDescription
issuerNamestringYesThe name of the staff member adding the note.
notestringYesThe note content to add.
Example Request Body
{
  "issuerName": "StaffMember",
  "note": "Player submitted an appeal via Discord. Reviewing evidence."
}

Response

200 OK

Response
{
  "success": true
}
FieldTypeDescription
successbooleanWhether the note was added successfully.

Error Responses

Status CodeDescription
400Invalid request body or missing required fields.
401Missing or invalid API key.
404Punishment not found.

On this page