BirthdayBot
Search…
⌃K

Commands

This page lists all usage and information about Birthday Bot's commands.

Prefix: /

Please note the space after bday in the prefix. Each command should be run as follows: /<command>
<> denotes an obligatory parameter, while [] refers to an optional one.
Example Command Usage: /set
For help with command arguments, view the Legend.

General

/premium - View information about Birthday Bot Premium.
/subscribe - Subscribe to Birthday Bot Premium.
/help category:premium - Help for Birthday Bot Premium.
/set date:[date] timezone:[timezone] user:[@User] - Set your birthday.
/view type:[type] user:[@User] - 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:[type] page:[page] - View the list of birthdays/anniversaries for the server.
/map - View the time zone map.
/vote - Vote for Birthday Bot.
/donate - Support Birthday Bot.
/link link:support - Join the support server
/link link:invite - Invite Birthday Bot.
/link link:docs- View Birthday Bot's documentation.
/link link:faq - View Birthday bot's FAQ.
/purge - Remove your birthday data. Note: This command doesn't reset your birthday attempts.

Information

/help - Help with Birthday Bot.
/help category:blacklist- Help for blacklist commands.
/help category:config - Help for config commands.
/help category::message- Help for message commands.
/help category:trusted_role- Help for the trusted_role commands.
/help category:member_anniversary_role- Help for mar commands.
/help premium - Help for Birthday Bot Premium.
/settings - View server's settings.
/donate - Donate to Birthday Bot!

Server Configuration (Administrators-only)

/test type:<type> user:[User] year:[anniversary year] - Test a Celebration event. Optional parameter of a user to mention and year (anniversaries only).
Setup Commands
/setup - Interactive guide for basic server setup.
/config setting:channel - Configure the channels Birthday Bot will use.
/config setting:role - Configure the birthday role or the birthday master role.
/config setting:timezone - Configure the Server Timezone setting.
/config setting:useTimezone - Configure the Use Timezone setting, which is the time zone that the bot will use to send celebration messages.
/config setting:nameFormat - Configure Name Format setting. Accepted values are mention, username, nickname, and tag.
/config setting:dateFormat - Configure Date Format setting.
Birthday Message Settings
/message list type:<type> page:[page] - List all custom messages of the given type.
/message add type:<type> message:<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 edit embed type:<type> position:<position> embed:<T/F> - Edit a pre-existing message's embed setting.
/message edit color type:<type> position:<position> color:<color/hex> - Edit a pre-existing message's color setting.
/message remove type:<type> position:<position> - Remove a certain custom message of the given type.
/message clear type:<type> - Clear all custom messages of the given type.
/message setting time type:<type> time:<0-23> - Set the custom message time of the given type.
/message setting mention type:<type> mention:<role/group> - Set the custom message mention of the given type.
/message test type:<type> position:<position> user_count:[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!
/trustedRole add role:<@Role> - Add a trusted role.
/trustedRole remove role:<@Role> - Remove a trusted role.
/trustedRole remove id:<Id> - Remove an Id.
/trustedRole list page:[page] - List all trusted roles.
/config setting:trustedPreventsMessage - Set if a trusted role is required for a birthday message.
/config setting:trustedPreventsRole - Set if a trusted role is required to get the birthday role.
/config setting:requireAllTrustedRoles - Set if users need all trusted roles.
Blacklist Settings
blacklist add role_or_user:<@User/@Role> - Add a user/role to the birthday blacklist.
blacklist remove id:<Id> - Remove an Id from the blacklist.
blacklist remove role_or_user:<@User/@Role> - Remove a user/role from the blacklist.
/blacklist clear - Clear the birthday blacklist.
/blacklist list page:[page] - View the birthday blacklist list.

Premium Commands

/premium - View information about your server's premium subscription.
/message color type:<type> position:<position> color:<color/hex> - Edit a pre-existing message's color setting.

User Specific Messages

Note: Set type to userSpecificBirthday or userSpecificMemberAnniversary for the following commands.
/message add type:<type> message:<message> - Add a message of the given type. It can add user-specific custom messages!
  • Example Usage: /message add type:birthday message:Happy Birthday @Stqlth! Hope you have a great day!
    • Placeholder for years (not in birthday messages): %Year%
    • Placeholder for the server name: %Server%
/message list type:<type>- List all user-specific-messages of the given type.
/message remove type:<type> position:<position> - Remove a user-specific-message of the given type at the given position.
/message clear type:<type> - Clear all user-specific custom messages of the given type.

Member Anniversary Roles

/mar add role:<@role> year:<year> - Add a member anniversary role for the given year.
/mar remove year:<year> - Remove all member anniversary roles for the given year.
/mar clear - Clear all member anniversary roles.
/mar list page:[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: /message list type:<type> page:[page]
In this command, you must give a type, but you do not have to give a page.
Some example usage:
/message list type:birthday - Shows the first list.
/message list type:birthday page:3 - Shows the third page of birthday messages.
Example Command: /list type:[type] page:[page]
In this command, you do not have to give a type or a page, but you can.
Some example usage:
/list - Shows the birthday list starting at the first page.
/list page:3 - Shows the birthday list starting at the third page.
/list type:memberAnniversary - Shows the member anniversary list starting at the first page.
/list type:memberAnniversary page: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 /list command
  • userSpecificBirthday - represents a user-specific birthday message
    • This type is only used in the /message list and /message clear commands
  • userSpecificMemberAnniversary - represents a user-specific member anniversary message
    • This type is only used in the /message list and /message clear commands