modl.gg

Acknowledge Notifications

Mark player notifications as acknowledged.

POST /v1/minecraft/notifications/acknowledge

Mark one or more player notifications as acknowledged. This is typically called after the plugin has displayed the notifications to the player in-game.

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.

Body

FieldTypeRequiredDescription
playerUuidstringYesThe UUID of the player whose notifications are being acknowledged.
notificationIdsstring[]YesArray of notification IDs to mark as acknowledged.
acknowledgedAtstringNoISO 8601 timestamp of when the notifications were acknowledged. Defaults to the current server time if not provided.
{
  "playerUuid": "550e8400-e29b-41d4-a716-446655440000",
  "notificationIds": [
    "notif_abc123",
    "notif_def456"
  ],
  "acknowledgedAt": "2024-01-15T12:00:00Z"
}

Response

200 OK

{
  "success": true,
  "message": "Notifications acknowledged successfully."
}

Error Responses

Status CodeDescription
400Invalid request body. Missing required fields or malformed data.
401Missing or invalid API key.
429Rate limit exceeded.
500Internal server error.

On this page