Modbot Docs
APIAPI referenceSettings

Update welcome steps

PUT/api/settings/discord-welcome

Save the welcome steps. via is dm, channel or both; the channel is needed for the last two. Every step is replaced by the lists sent: at most 25 rules (a role, a text of at most 80 characters on one line, and an optional https link) and at most 3 default steps. A member who holds a rule's role is sent its step; defaults fill up to three. linkButton adds a button to the account link page for a member who has not linked. Switching on needs at least one step, and welcomes only members who join after that.

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/discord-welcome" \  -H "Content-Type: application/json" \  -d '{    "enabled": true,    "via": "string",    "channelId": null,    "linkButton": true,    "rules": null,    "defaults": null  }'
{  "enabled": true,  "via": "string",  "channelId": null,  "linkButton": true,  "rules": [    {      "roleId": "string",      "text": "string",      "link": null    }  ],  "defaults": [    {      "text": "string",      "link": null    }  ],  "mostRules": 0,  "mostDefaults": 0,  "mostTextLength": 0}

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.