Update list
/api/lists/{id}Change a list's name or rules. A list a giveaway still being run names needs Run giveaways as well; one auto-invites names needs Set up auto-invites; one a Discord role is given from needs Manage role and ban sync.
Needs the ManageLists permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Path Parameters
uuidRequest 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
application/problem+json
curl -X PUT "https://example.com/api/lists/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "rules": null }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "rules": null, "ruleLines": [ "string" ], "createdBy": null, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "usedBy": { "giveaways": [ "string" ], "autoInvites": true, "events": null, "discordRoles": null }}Delete list DELETE
Delete a list. Refused while a giveaway still being run, auto-invites, an event still being run, or a Discord role given from the list names it. Needs the `ManageLists` permission.
Export list POST
Everybody in a list right now, as a CSV or JSON file. The file leaves Modbot: once downloaded, retention and purge no longer reach it. Every export is recorded with who asked, the format, how many people and which columns. Needs the `ViewMembers` and `ViewProfile` permissions.