Commands

Prefix: bday 
Please note the space after bday in the prefix. Each command should be run as follows:
bday <command>
<> denotes an obligatory parameter, while [] refers to an optional one.
Example Command Usage: bday set
For help with command arguments, view the Legend.
General
premium - View information about Birthday Bot Premium.
subscribe - Subscribe to Birthday Bot Premium.
help premium - Help for Birthday Bot Premium.
set - Set your birthday.
view [type] [name] - View your information or a user's information. type can be birthday or memberAnniversary. If it's not specified, the default is birthday.
next [type] - View the next celebration event(s) in the server. 
list [type] [page/date] - View the list of birthdays/anniversaries for the server.
map - View the time zone map.
invite - Invite Birthday Bot to a server.
support - Join the support server.
docs - View the documentation for Birthday Bot.
faq - View the FAQ for Birthday Bot.
vote - Vote for Birthday Bot.
purge - Remove your birthday data. Note: This command doesn't reset your birthday attempts.
Information
help - Help with Birthday Bot.
help setup - Help for server setup.
help setup anniversary - Help for the anniversary system.
help setup message - Help for the birthday message settings.
help trusted - Help for the trusted system.
help blacklist - Help for the birthday blacklist.
help premium - Help for Birthday Bot Premium.
settings - View server's settings.
donate - Donate to Birthday Bot!
Server Configuration (Administrators-only)
test <type> [User] [anniversary year] - Test a Celebration event. Optional parameter of a user.
Setup Commands
setup - Interactive guide for server setup.
config channel <type> <create/clear/#channel> - Configure the channel for the given type.
config role <create/clear/@role> - Configure the birthday role.
config birthdayMasterRole <create/clear/@role> - Configure the birthday master role.
config timezone <timezone> - Configure the Server Timezone setting.
config useTimezone <user/server> - Configure the Use Timezone setting, which is the time zone that the bot will use to send celebration messages.
config nameFormat <setting> - Configure Name Format setting. Accepted values are mention, username, nickname, and tag.
config dateFormat <month/day or day/month> - Configure ​Date Format setting. 
Birthday Message Settings
message list <type> [page] - List all custom messages of the given type.
message add <type> <message> - Add a custom birthday message. <Users> is the placeholder for the messages to mention the birthday users. Note: Only Premium servers can set user-specific messages.
message embed <type> <position> <T/F> - Edit a pre-existing message's embed setting.
message color <type> <position> <color/hex> - Edit a pre-existing message's color setting.
message remove <type> <position> - Remove a certain custom message of the given type.
message clear <type> - Clear all custom messages of the given type.
message time <type> <0-23> - Set the custom message time of the given type.
message mention <type> <role/group> - Set the custom message mention of the given type.
message test <type> <position/user> [user count] - Test a custom message of the given type.
Trusted System Settings
NOTE: The free version of Birthday Bot can only have one trusted role. Check out Birthday Bot Premium!
setup trusted - Interactive guide for trusted system settings setup.
trustedRole add <role> - Create a trusted role.
trustedRole remove <role/position> - Remove a trusted role.
trustedRole list [page] - List all trusted roles.
config trustedPreventsMessage <T/F> - If a trusted role is required for a birthday message.
config trustedPreventsRole <T/F> - If a trusted role is required to get the birthday role.
config requireAllTrustedRoles <T/F> - If users need all trusted roles.
Blacklist Settings
blacklist add <User/Role/Id> - Add a user/role to the birthday blacklist.
blacklist remove <User/Role/Id> - Remove a user/role from the blacklist.
blacklist clear - Clear the birthday blacklist.
blacklist list [page] - View the birthday blacklist list.
Premium Commands
premium - View information about your server's premium subscription.
message add <type> <message> - Add a message of the given type. It can add user-specific custom messages!
Example Usage: bday message add <type> Happy Birthday @Stqlth! Hope you have a great day!
Placeholder for years (not in birthday messages): <Year>
Placeholder for the server name: <Server>
message color <type> <position> <color/hex> - Edit a pre-existing message's color setting.
message remove <type> @User - Remove a user-specific custom message of the given type.
message remove <type> @User - Remove a user-specific custom message of the given type.
message clear <type> - Clear all user-specific custom messages of the given type.
memberAnniversaryRole add <role> <year> - Add a member anniversary role for the given year.
memberAnniversaryRole remove <role> - Remove a member anniversary role.
memberAnniversaryRole clear - Clear all member anniversary roles.
memberAnniversaryRole list [page] - List the member anniversary roles.
Legend
Argument Requirements
Commands which allow/take arguments will be displayed with either [] or <>. Arguments in [] are not required while those in <> are required. If an argument in either [] or <> has a / between two things it means OR.
Example Command: bday message list <type> [page]
In this command, you must give a type, but you do not have to give a page.
Some example usage:
bday message list birthday - Shows the first list.
bday message list birthday 3 - Shows the third page of birthday messages.
Example Command: bday list [type] [page/date]
In this command, you do not have to give a type, but you can give a page or date.
Some example usage:
bday list - Shows the birthday list starting at the first page.
bday list 3 - Shows the birthday list starting at the third page.
bday list memberAnniversary - Shows the member anniversary list starting at the first page.
bday list memberAnniversary 3 - Shows the member anniversary list starting at the third page.
group accepted values: everyone, here, and none.
Argument Types
Multiple commands require or allow the type argument, this can appear as [type] or <type>.
This is the celebration event type, though it varies between commands slightly:
birthday - represents the birthday event of a user
memberAnniversary - represents the member anniversary event of a user
serverAnniversary - represents the server anniversary event of a server
This type can't be used in the bday list command
userSpecificBirthday - represents a user-specific birthday message
This type is only used in the bday message list and bday message clear commands
userSpecificMemberAnniversary - represents a user-specific member anniversary message
This type is only used in the bday message list and bday message clear commands
Setting Your Birthday
Premium Features
Last modified 3mo ago
Copy link
Contents
General
Information
Server Configuration (Administrators-only)
Premium Commands
Legend