Modbot Docs
APIAPI referenceSettings

Update supporter settings

PUT/api/settings/supporters

Switch Ko-fi or Patreon on or off, save the verification token from Ko-fi's webhook page, the webhook secret from Patreon's and the four keys of the Patreon client (client id, client secret, creator access token, creator refresh token), all kept encrypted and never returned; saving a new key starts the Patreon catch-up over. Set how many days after the paid month ends each site's supporters lose the roles (0 to 365, or -1 for never) and set the thank-you message. Neither can be switched on without its token or secret. While either is on the bot's invite link asks for Manage Roles, so a bot added earlier has to be added again from the new link.

Needs the ManageSettings permission.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X PUT "https://example.com/api/settings/supporters" \  -H "Content-Type: application/json" \  -d '{    "kofiOn": null,    "verificationToken": null,    "thanksText": null  }'
{  "kofiOn": true,  "tokenStored": true,  "thanksText": "string",  "webhookAddress": null,  "mostThanksLength": 0,  "patreonOn": true,  "patreonSecretStored": true,  "patreonWebhookAddress": null,  "kofiRolesOffDays": 0,  "patreonRolesOffDays": 0,  "mostRolesOffDays": 0,  "patreonClientIdStored": true,  "patreonClientSecretStored": true,  "patreonAccessTokenStored": true,  "patreonRefreshTokenStored": true,  "patreonCatchUpAt": null,  "patreonCatchUpProblem": null}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.