Get welcome steps
/api/settings/discord-welcomeThe 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.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Response Body
application/json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/settings/discord-welcome"{ "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}Update join gate settings PUT
Save the join gate's settings. `mode` is off, watch (record what would happen, do nothing in Discord) or on. Changing the mode ends everybody's current time at the gate and gates only people who join from then on. `removeAfterMinutes` is one of `removeChoices`, or null for never; changing it, or the steps, starts everybody waiting no later than halfway again, with a new warning. `needsEighteenPlus` needs `needsLink`, and `needsLink` needs account linking to be set up. Needs the `ManageSettings` permission.
Update welcome steps PUT
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.