PATCH
/api/v1/server/logs/{logId}
Request
Response
200
Success
Authorization
AuthorizationstringrequiredYour API token as
Bearer YOUR_TOKEN. Create one in your server's dashboard settings.Path parameters
logIdstringrequiredBody
performedBystringrequiredMember ID of the staff member editing the log.
descriptionstring | nullExtra details. Needs premium.
resetPunishmentsCountboolean | nullReset the player's punishment count. Notes only.
tempBanboolean | nullMake the ban temporary, or permanent with
false. Bans only.textstring | nullReason.
typeinteger | nullNew log type.
typeIdstring | nullCustom log type ID. Required when changing
type to 5.unbanAtinteger | nullWhen a temporary ban ends, up to a year away.
usernamestring | nullRoblox username of the player.
Response
200 Success
createdAtintegerrequiredWhen it was created.
createdBystringrequiredMember ID of the staff member who created it, or
SYSTEM.editedBystring[]requiredMember IDs of everyone who edited it.
idstringrequiredUnique ID.
proofstring[]requiredProof file keys.
serverIdstringrequiredServer ID.
textstringrequiredReason.
typeintegerrequiredLog type:
0 Warning, 1 Kick, 2 Ban, 3 Ban BOLO, 4 Note or 5 Custom.usernamestringrequiredRoblox username of the player.
completedBystring | nullFor ban BOLOs, member ID of who completed it.
deniedBystring | nullFor ban BOLOs, member ID of who denied it.
descriptionstring | nullExtra details.
dontCountboolean | nullWhether it's left out of punishment counts.
expiredboolean | nullWhether it has expired.
expiredAtinteger | nullWhen it expired.
expiredBystring | nullMember ID of who expired it.
hiddenboolean | nullWhether it's hidden from the player.
hiddenBystring | nullMember ID of who hid it.
robloxIdstring | nullRoblox user ID of the player.
tempBanboolean | nullWhether the ban is temporary.
typeIdstring | nullCustom log type ID, when
type is 5.unbanAtinteger | nullWhen a temporary ban ends.
Errors
| Status | Meaning |
|---|---|
400 | Invalid request. validation_failed lists each invalid field in details.fields. |
401 | Missing, invalid or expired token |
403 | Success |
404 | Not found |
429 | Rate limited. See Retry-After and details. |
500 | Internal server error |
502 | next did not confirm the write. Check whether it applied before retrying. |
503 | Write endpoints are not configured on this deployment |