REST API Documentation
/core/warnreasons
Create a 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
Name | Type | Description |
---|---|---|
Required
name
|
string | Name for the warn reason |
defaultNotes
|
string | Default notes to associate with the warn reason |
points
|
int | Default points to be issued with the warn reason |
pointsOverride
|
bool | Whether or not moderators can override the default points |
pointsAutoRemove
|
bool | Whether or not to automatically remove points (defaults to false). If true, you must supply removePoints. |
removePoints
|
string|null | Timeframe to remove points after as a date interval (e.g. P2D for 2 days or PT6H for 6 hours) |
removeOverride
|
bool | Whether or not moderators can override the default points removal configuration |
Exceptions
Code | Message | Description |
---|---|---|
1C385/2 |
INVALID_POINTS_EXPIRATION |
Points were specified as automatically removing but the removal time period was not supplied or is invalid |
1C385/4 |
NO_NAME |
A name for the warn reason must be supplied |
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 |