Update join gate settings
/api/settings/discord-gateSave 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.
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-gate" \ -H "Content-Type: application/json" \ -d '{ "mode": "string", "memberRoleId": null, "channelId": null, "message": null, "needsLink": true, "needsEighteenPlus": true, "removeAfterMinutes": null, "holdOnSpike": true, "pauseInvites": true }'{ "mode": "string", "memberRoleId": null, "channelId": null, "message": null, "needsLink": true, "needsEighteenPlus": true, "removeAfterMinutes": null, "removeChoices": [ 0 ], "holdOnSpike": true, "pauseInvites": true, "heldSince": null, "linkingReady": true, "inviteUrl": null}Get join gate settings GET
The Discord join gate's settings: its mode, the member role, the gate channel and message, the steps, the removal time and join spike protection. Needs the `ManageSettings` permission.
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.