modl.gg

Acknowledge Punishment

Mark a punishment as acknowledged and started on the server.

POST /v1/minecraft/punishments/acknowledge

Mark a punishment as acknowledged by the server, indicating that the punishment has been received and enforcement has begun. This is typically called by the Minecraft plugin after successfully applying a punishment to a player.

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.

Body

FieldTypeRequiredDescription
punishmentIdstringYesThe ID of the punishment to acknowledge.
playerUuidstringYesThe UUID of the punished player.
executedAtstringNoISO 8601 timestamp of when the punishment was executed on the server.
successbooleanYesWhether the punishment was successfully applied.
errorMessagestringNoError details if the punishment failed to apply.
Example Request Body
{
  "punishmentId": "6651a2f8e4b0c1d2e3f4a5b6",
  "playerUuid": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
  "executedAt": "2025-01-15T12:00:00Z",
  "success": true
}

Response

200 OK

Response
{
  "message": "Punishment acknowledged successfully."
}
FieldTypeDescription
messagestringA human-readable success message.

Error Responses

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

On this page