-
Notifications
You must be signed in to change notification settings - Fork 3
System Guild Settings
greysdawn edited this page Aug 28, 2023
·
2 revisions
These can't be instantiated directly. See the API page for getting them
See PK's docs for more info on each property
| key | type | notes |
|---|---|---|
| guild | string | not present in API itself- added when instantiated |
| proxying_enabled | boolean | |
| tag | string | |
| tag_enabled | boolean |
Note: While some token arguments are marked as not optional, if the API instance has a token attached then it can be omitted
Patches Settings with object's current values
Arguments
| name | description | optional? |
|---|---|---|
| token | A token to auth the request | no |
Returns
Updated System Guild Settings object, with the patched values
Errors
Throws for the following:
- Token invalid
- Data invalid
Verifies the object's properties. Intended for internal use
Returns
A plain object with verified and properly transformed props
Errors
Errors for any property that isn't valid- returns all errors as a string when finished verifying
credit to xSke for Pluralkit