Update welcome steps
/api/settings/discord-welcomeSave 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.
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}Get welcome steps GET
The steps a new Discord member is sent: whether it is on, where it goes, the rules that pick a step from a role, and the default steps. Needs the `ManageSettings` permission.
List role menus GET
The role menus Modbot posts in Discord, each with the roles it gives and whether its message is up. Needs the `ManageSettings` permission.