REST API Documentation
/core/warnreasons/{id}
Get specific warn reason
This endpoint is only available for requests made using an API Key or the Client Credentials Grant Type, not using an OAuth Access Token for a particular member.
Parameters
No parameters are accepted for this endpoint.
Exceptions
Code | Message | Description |
---|---|---|
1C385/1 |
INVALID_ID |
The warn reason does not exist |
Response
Name | Type | Description |
---|---|---|
id
|
int | ID number |
name
|
string | Warn reason name |
defaultNotes
|
string | Default notes for warning (moderator can override) |
points
|
int | The warning points levied with the warning |
pointsOverride
|
bool | Whether the moderator can override the default points or not |
removeOverride
|
bool | Whether the moderator can override when the points will be removed or not |
removePoints
|
string|null | Time frame as a date interval when points will automatically be removed, or null if points do not automatically remove |
pointsAutoRemove
|
bool | Whether points are automatically removed or not |