# Get Image Counts
Source: https://docs.miona.bot/api-reference/endpoint/count

GET /count



# Get PFP
Source: https://docs.miona.bot/api-reference/endpoint/image

GET /image/{id}



# Get Matching PFPs
Source: https://docs.miona.bot/api-reference/endpoint/match

GET /match/{type}



# Get Random PFP
Source: https://docs.miona.bot/api-reference/endpoint/random

GET /random/{type}



# Introduction
Source: https://docs.miona.bot/api-reference/introduction

An overview of the Miona API

## Authorization

All of the API endpoints are protected by an API Key. You can purcahse one from our [patreon page.](https://miona.bot/patreon)
The API Key should be passed as a header with the key `Authorization` and the value `<API_KEY>`.

```
Authorization: <API_KEY>
```


# AutoMatch
Source: https://docs.miona.bot/autopost/automatch

Automatically send two random matching profile pictures in a channel.

AutoPFP is a feature that sends random profile pictures in a channel to engage your community. It provides a great way to find new matching profile pictures for you and your beloved once.

<Frame>
  <img alt="Example AutoMatch message" />
</Frame>

# ⚙️ How to set it up?

To set it up you just need to run the following command:

```sh theme={null}
/autopost automatch start <delay> [channel]
```

The `<delay>` argument is the delay between the pfps and it's required.

<Warning>
  The minimum `<delay>` is `1 minute` and if you want to decrease the delay please consider supporting us on our patreon store [here](https://patreon.com/MionaBot).

  Also there is a limit of `1` automatch channel per server, if you want to increase this limit please consider supporting us on our patreon store [here](https://patreon.com/MionaBot).
</Warning>

After this step you need to choose the types of PFPs that you want the bot to send.

<Frame>
  <img alt="Selecting PFP types" />
</Frame>

<Note>
  You can select multiple image types for one channel.
</Note>

After setting up the autopfp, you might be asked to vote for the bot if you haven't already.

<Note>
  The bot will ask you to vote every **48 hours**.

  Servers with active `Premium` and `Platinum` subscriptions are not required to vote.
  Check out our [Patreon Store](https://patreon.com/MionaBot) to learn more.
</Note>

<Frame>
  <img alt="Example Vpting message" />
</Frame>

<Warning>
  When you are voting, please use the link that is given to you by the bot or by running `/vote` in your server, because the link given by the bot is unique and identifies your server. This is the only way for us to know for which server you've voted.
</Warning>

After you've voted the bot should start sending matching PFPs of the desired types.

# ❌ How to disable?

You can disable AutoMatch by running the following command:

```sh theme={null}
/autopost automatch stop [channel]
```

If you don't specify a channel, the channel where you are running the command will be used.

# 📋 How to see your AutoMatch channels?

You can see your AutoMatch channels by running the following command:

```sh theme={null}
/autopost automatch list
```

<Frame>
  <img alt="Example AutoMatch list" />
</Frame>


# AutoMeme
Source: https://docs.miona.bot/autopost/automeme

Automatically send fresh memes in a channel.

**AutoMeme** is a feature that engages your community by sending fresh, random memes to a channel. It's a great way to spark fun and keep your community entertained!

<Frame>
  <img alt="Example AutoMeme message" />
</Frame>

## ⚙️ How to set it up?

To set it up, just run the following command:

```sh theme={null}
/autopost automeme start <delay> [channel]  
```

The `<delay>` argument specifies the delay between the memes and is required.

<Warning>
  The minimum `<delay>` is `1 minute`. If you want to decrease the delay, please consider supporting us on our Patreon store [here](https://patreon.com/MionaBot).

  Additionally, there is a limit of `1` AutoMeme channel per server. To increase this limit, consider supporting us on our Patreon store [here](https://patreon.com/MionaBot).
</Warning>

After setting up AutoMeme, you might be asked to vote for the bot if you haven't already.

<Note>
  The bot will ask you to vote every **48 hours**.

  Servers with active `Premium` and `Platinum` subscriptions are not required to vote.\
  Check out our [Patreon Store](https://patreon.com/MionaBot) to learn more.
</Note>

<Frame>
  <img alt="Example Voting message" />
</Frame>

<Warning>
  When you are voting, please use the link provided by the bot or by running `/vote` in your server. The link provided by the bot is unique and identifies your server. This is the only way for us to confirm your vote.
</Warning>

After you've voted, the bot will start sending fresh memes in your selected channel.

## ❌ How to disable?

You can disable AutoMeme by running the following command:

```sh theme={null}
/autopost automeme stop [channel]  
```

If you don't specify a channel, the channel where you run the command will be used.

## 📋 How to see your AutoMeme channels?

You can see your AutoMeme channels by running the following command:

```sh theme={null}
/autopost automeme list  
```

<Frame>
  <img alt="Example AutoMeme list" />
</Frame>


# AutoPFP
Source: https://docs.miona.bot/autopost/autopfp

Automatically sends random profile pictures in a channel to engage your community.

AutoPFP is a feature that sends random profile pictures in a channel to engage your community. It provides a great way to find new and good looking profile pictures and engage your members.

<Frame>
  <img alt="Example AutoPFP message" />
</Frame>

# ⚙️ How to set it up?

First you need to run the following command:

```sh theme={null}
/autopost autopfp start <delay> [channel]
```

The `<delay>` argument is the delay between the pfps and it's required.

<Warning>
  The minimum `<delay>` is `1 minute` and if you want to decrease the delay please consider supporting us on our patreon store [here](https://patreon.com/MionaBot).

  Also there is a limit of `5` autopfp channels per server, if you want to increase this limit please consider supporting us on our patreon store [here](https://patreon.com/MionaBot).
</Warning>

After this step you need to choose the types of PFPs that you want the bot to send.

<Frame>
  <img alt="Selecting PFP types" />
</Frame>

<Note>
  You can select multiple image types for one channel.
</Note>

After setting up the autopfp, you might be asked to vote for the bot if you haven't already.

<Note>
  The bot will ask you to vote every **48 hours**.

  Servers with active `Premium` and `Platinum` subscriptions are not required to vote.
  Check out our [Patreon Store](https://patreon.com/MionaBot) to learn more.
</Note>

<Frame>
  <img alt="Example AutoPFP message" />
</Frame>

<Warning>
  When you are voting, please use the link that is given to you by the bot or by running `/vote` in your server, because the link given by the bot is unique and identifies your server. This is the only way for us to know for which server you've voted.
</Warning>

After you've voted the bot should start sending random PFPs of the desired types.

# ❌ How to disable?

You can disable AutoPFP by running the following command:

```sh theme={null}
/autopost autopfp stop [channel]
```

If you don't specify a channel, the channel where you are running the command will be used.

# 📋 How to see your PFP channels?

You can see your PFP channels by running the following command:

```sh theme={null}
/autopost autopfp list
```

<Frame>
  <img alt="Example AutoPFP message" />
</Frame>


# Boost Messages
Source: https://docs.miona.bot/greeting/boost

Send a message when a member boosts your server

Boost messages are special announcements sent whenever a member boosts your server. Miona allows you to create fully customizable boost messages, making it easy to celebrate and show appreciation for those who support your community.

💬 You can personalize these messages with text, images, or embeds, adding a unique touch to each boost. It's a great way to thank your boosters 🙌 and highlight their contribution, encouraging others to join in too!

<Frame>
  <img alt="Example Boost message" />
</Frame>

<Note>
  Boost messages require a `System Messages Channel` and the option `Send a message when someone boosts this server` enabled in your server settings.

  <img alt="Server settings" />

  This channel doesn’t need to be visible to everyone — only the bot must have permission to read messages in it.
</Note>

## 🚀 How to Set It Up

First, create your boost message by using the following command:

```sh theme={null}
/boost setmessage
```

Once you run this, the built-in editor will open so you can start customizing your message.

<Frame>
  <img alt="Editing boost message with built-in editor" />
</Frame>

Use the buttons to update message properties. For example, click **Edit basic information** to modify the embed title, description, color, and more.

<Note>
  Changes made in the built-in editor are saved automatically.
</Note>

Next, set the channel where the boost message will be sent:

```sh theme={null}
/boost setchannel <channel>
```

✅ You can test your boost message anytime using:

```sh theme={null}
/boost test
```

## ❌ How to Disable Boost Messages

To disable boost messages, simply run:

```sh theme={null}
/boost removechannel
```

## 🧠 Variables

You can view the list of available variables [here](/variables).


# JoinDM Messages
Source: https://docs.miona.bot/greeting/joindm

Send direct message when a member joins your server

Join DM messages are personalized messages sent directly to a user's DM when they join your server. Miona allows you to create fully customizable join DM messages, which can be a great way to introduce new members to your community. These messages are perfect for sending your server's advertisement, rules, or any important information that helps users get started. With join DM messages, you can provide a welcoming, informative experience right in the user's inbox, making it easier to engage and guide new members.

<Frame>
  <img alt="Example Join DM message" />
</Frame>

## 🚀 How to set it up?

Firstly we need to create the message. You can do that by running the following command:

```sh theme={null}
/joindm setmessage
```

Once you run this command the built-in editor will open and you can start editing your message.

<Frame>
  <img alt="Editing join DM message with built-in editor" />
</Frame>

By clicking on each button, you can edit the properties of the message/embed, for example by clicking on the `Edit basic information` you can edit the embed `Title`, `Description`, `Color`, etc.

<Note>
  Built-in editor automatically saves your changes.
</Note>

After this step the bot will automatically send the message to the users DM when they join the server.
You can test this message by running the following command:

```
/joindm test
```

## ❌ How to disable?

You can disable join DM messages by running the following command:

```sh theme={null}
/joindm disable
```

## 🧠 Variables

You can use variables in most messages where Built-in editor is used.\
You can find the list of variables [here](/variables).


# Leave Messages
Source: https://docs.miona.bot/greeting/leave

Send message when a member leaves your server

Leave messages are similar to welcome messages but are sent when a member leaves your server. Miona allows you to create fully customizable leave messages, making it easy to inform your community whenever someone leaves. You can personalize these messages with text, images, or embeds, using variables to include specific details like the member's username or the current member count. This allows you to create a unique and informative message that matches your server's style.

<Frame>
  <img alt="Example Leave message" />
</Frame>

## ⚙️ How to set it up?

Firstly we need to create the message. You can do that by running the following command:

```sh theme={null}
/leave setmessage
```

Once you run this command the built-in editor will open and you can start editing your message.

<Frame>
  <img alt="Editing leave message with built-in editor" />
</Frame>

By clicking on each button, you can edit the properties of the message/embed, for example by clicking on the `Edit basic information` you can edit the embed `Title`, `Description`, `Color`, etc.

<Note>
  Built-in editor automatically saves your changes.
</Note>

Next we need to set the channel where the message will be sent. You can do that by running the following command:

```sh theme={null}
/leave setchannel <channel>
```

After this step the bot will automatically send the message to the channel when someone leaves your server.
You can test this message by running the following commands:

```
/leave test
```

## ❌ How to disable?

You can disable boost messages by running the following command:

```sh theme={null}
/leave removechannel
```

## 🧠 Variables

You can use variables in most messages where Built-in editor is used.\
You can find the list of variables [here](/variables).

<Note>
  Keep in mind that `{member_mention}` sometimes might result in @Unknown-user as that user left the server and might be visible to the bot.
</Note>


# Ping On Join
Source: https://docs.miona.bot/greeting/poj

Ping a member in a channel when they join your server.

Ping on Join (POJ) is a feature that pings a new member in a specific channel as soon as they join the server. This directs their attention to that channel first, ensuring they see important information, guidelines, or introductions immediately. POJ is a great way to highlight key channels for newcomers, making sure they don’t miss important messages or community updates right from the start.

<Frame>
  <img alt="Example POJ message" />
</Frame>

These pings can be sent either in a batch or individually, with a time window of 1 second. This means that if two members join the server within the same second, only one ping will be sent to avoid overlapping notifications. The time window ensures that pings are efficiently managed without excessive spamming when multiple members join at the same time.

## ⚙️ How to set it up?

To set it up you just need to run the following command:

```sh theme={null}
/poj start <channel> [delay]
```

The `[delay]` argument is the time it takes the bot to remove the ping from the channel, by default it's set to `1 second`.
After this step the POJ feature should be enabled and working.

## ❌ How to disable?

You can disable POJ messages by running the following command:

```sh theme={null}
/poj stop [channel]
```

# 📋 How to see where POJ is enabled?

You can see where POJ is enabled by running the following command:

```sh theme={null}
/poj list
```


# Welcome Messages
Source: https://docs.miona.bot/greeting/welcome

Send message when a new member joins your server

Welcome messages are a powerful way to greet new members as soon as they join your server. Miona allows you to create fully customizable welcome messages, giving you the flexibility to introduce newcomers in a way that reflects your community's style and personality. Whether you want to include personalized text, images, or embeds, Miona’s welcome messages can be tailored to provide a unique and engaging introduction for every new member.

<Frame>
  <img alt="Example Welcome message" />
</Frame>

## ⚙️ How to set it up?

Firstly we need to create the message. You can do that by running the following command:

```sh theme={null}
/welcome setmessage
```

Once you run this command the built-in editor will open and you can start editing your message.

<Frame>
  <img alt="Editing welcome message with built-in editor" />
</Frame>

By clicking on each button, you can edit the properties of the message/embed, for example by clicking on the `Edit basic information` you can edit the embed `Title`, `Description`, `Color`, etc.

<Note>
  Built-in editor automatically saves your changes.
</Note>

Next we need to set the channel where the message will be sent. You can do that by running the following command:

```sh theme={null}
/welcome setchannel <channel>
```

After this step the bot will automatically send the message to the channel when someone joins your server.
You can test this message by running the following commands:

```
/welcome test
```

## ❌ How to disable?

You can disable boost messages by running the following command:

```sh theme={null}
/welcome removechannel
```

## 🧠 Variables

You can use variables in most messages where Built-in editor is used.
You can find the list of variables [here](/variables).


# Introduction
Source: https://docs.miona.bot/introduction

Welcome to the Miona Docs

<img alt="Hero Light" />

<img alt="Hero Dark" />

## Work in progress

This documentation is still a work in progress. If you have any suggestions or
feedback, please feel free to open an issue or pull request on the [GitHub repository](https://github.com/miona-cc/docs/tree/main).
If you want to contribute, please make a pull request to the
`main` branch.

## What is Miona?

Miona is a versatile and highly customizable Discord bot designed to enhance your server with a wide range of powerful features. Its core strength lies in the ability to customize nearly every aspect, allowing you to tailor the bot’s behavior to fit your community perfectly. Here’s a breakdown of what Miona offers:

* **🖼️ AutoPFP**: Automatically sends random profile pictures in a channel to engage your community.
* **🔗 AutoMatch**: Automatically sends random matching profile pictures in a channel.
* **😂 Auto Meme**: Shares trending memes directly in your server to keep the fun going.
* **👋 Customizable Greeting System**: Create personalized welcome, leave, and boost messages to give your server a unique touch.
* **🎉 Giveaways System**: Host and manage giveaways effortlessly with fully customizable options.
* **🎫 Customizable Tickets System**: Set up a ticketing system for support and queries that suits your needs, with adjustable templates and categories.
* **🏷️ Auto Roles**: Automatically assign roles to new members, streamlining onboarding and organization.
* **📈 Invites Tracker**: Track server invites to see who’s bringing in new members.
* **🛡️ Moderation Tools**: Utilize advanced moderation features to keep your server safe and well-managed.
* **🌟 Vanity Roles**: Allow members to earn or choose special roles for themselves, adding a personalized flair.
* **📊 Custom Counters**: Display server stats such as online members, offline members, and more with fully customizable counters.
* **📑 Customizable Embeds**: Create and customize detailed Discord messages with embeds. Miona features both a built-in embed editor and an online editor, giving you full control over how your messages look.
* and much more...

Miona stands out by offering the highest level of customization, enabling you to fine-tune every feature according to your community's needs.


# Mentions
Source: https://docs.miona.bot/mentions

How to mention Discord users, roles, and channels inside Miona messages

When customizing your messages in **Miona**, you may want to mention Discord roles, channels, or users. Discord uses a special formatting syntax for these mentions. Below is a full guide on how to use them inside your Miona message templates.

***

## 🧩 Mentioning Roles

To mention a role, use the following format:

```

<@&ROLE_ID>

```

Replace `ROLE_ID` with the actual ID of the role.

**Example:**

```

<@&123456789012345678>

```

***

## 📺 Mentioning Channels

To mention a channel, use:

```

<#CHANNEL_ID>

```

Replace `CHANNEL_ID` with the ID of the channel you want to reference.

**Example:**

```

<#987654321098765432>

```

***

## 👤 Mentioning Users

To mention a user directly, use:

```

<@USER_ID>

```

**Example:**

```

<@112233445566778899>

```

***

## 🔧 Dynamic Mentions (Using Miona Variables)

Miona supports dynamic variables that let you mention users involved in events without manually inserting their IDs.

You can use:

```

<@{member_id}>

```

or simply:

```

{member_mention}

```

These will automatically mention the relevant member when the message is sent.

***

## ✔ Summary

| Entity       | Format             | Example                     |
| ------------ | ------------------ | --------------------------- |
| Role         | `<@&ROLE_ID>`      | `<@&123456789012345678>`    |
| Channel      | `<#CHANNEL_ID>`    | `<#987654321098765432>`     |
| User         | `<@USER_ID>`       | `<@112233445566778899>`     |
| Dynamic User | `{member_mention}` | Mentions user automatically |

***

This formatting works in both Discord messages and Miona's message builder, ensuring your bot sends clean, functional mentions every time.


# Auto Responders
Source: https://docs.miona.bot/more-features/autoresponders

Automatically respond to messages using triggers and actions

🤖 **Auto Responders**

Auto Responders allow you to set up automatic replies or reactions based on specific triggers. This feature is useful for answering common questions, acknowledging certain phrases, or enhancing interactivity in your server.

<Frame>
  <img alt="Example autoresponder" />
</Frame>

## 🔥 Features

✅ Trigger-based responses – Supports plain text and regex patterns\
✅ Two response types – Send a message or react with an emoji\
✅ Easy management – Edit, import, and delete with simple commands

## 🛠️ Commands

### 🔹 Create an Auto Responder

```sh theme={null}
/autoresponders create <name> <trigger> <response-type> [channel]
```

* **Name**: (Optional) Used to organize your responders
* **Trigger**: A text string or regular expression
* **Response Type**: `message`, `reaction` or `role`
* **Channel**: (Optional) Restrict the responder to a specific channel

### 🔹 Edit the Response

```sh theme={null}
/autoresponders edit-response <auto-responder>
```

Modify the message that will be sent when the responder is triggered.

### 🔹 Import a Saved Embed

```sh theme={null}
/autoresponders import-embed <auto-responder> <embed>
```

Use a saved embed as the response for an auto responder.

### 🔹 Delete an Auto Responder

```sh theme={null}
/autoresponders delete <auto-responder>
```

Remove an existing auto responder.

### 🔹 View All Auto Responders

```sh theme={null}
/autoresponders list
```

See a list of all active auto responders.


# Giveaways
Source: https://docs.miona.bot/more-features/giveaway

Host interactive giveaways in any channel you choose.

Giveaways are a fun and effective way to engage your community and distribute rewards. You can set up fully customizable giveaways in any channel, choose how long they last, and let members join or leave with ease.

<Frame>
  <img alt="Example giveaway" />
</Frame>

## 🎉 How to Start a Giveaway

To begin a giveaway, simply run:

```sh theme={null}
/giveaway start
```

After running the command, a form will appear where you can fill in the giveaway details such as:

* Prize
* Duration
* Number of winners
* Description

Click **Submit** to launch the giveaway!

<Frame>
  <img alt="Giveaway form example" />
</Frame>

A giveaway embed will be posted in the current channel, along with a join button for members.

## ⚙️ Editing Giveaway Settings

To customize the appearance and behavior of giveaways, use:

```sh theme={null}
/giveaway settings
```

You’ll be able to modify:

* Embed color
* Join button emoji
* Button label

<Frame>
  <img alt="Giveaway settings" />
</Frame>

## 🔁 Rerolling a Winner

Need to pick a new winner? After a giveaway ends, run:

```sh theme={null}
/giveaway reroll <giveaway_id> [winners_count]
```

## ⏹️ Ending a Giveaway Early

To forcibly end an ongoing giveaway and pick a winner immediately, use:

```sh theme={null}
/giveaway end <giveaway_id>
```

## 👥 Viewing Giveaway Participants

To view all participants (entries) in a giveaway, use:

```sh theme={null}
/giveaway entries <giveaway_id>
```

## 🗑️ Deleting a Giveaway

If you want to cancel a giveaway without drawing a winner, use:

```sh theme={null}
/giveaway delete <giveaway_id>
```

The giveaway will be removed immediately.

## 📋 Viewing Active Giveaways

To see a list of all currently active giveaways, run:

```sh theme={null}
/giveaway list
```

<Frame>
  <img alt="Active giveaways list" />
</Frame>


# Invite Tracker
Source: https://docs.miona.bot/more-features/invites-tracker

Track and manage invites and inviters in your server.

The **Invite Tracker** allows administrators to monitor how members join the server, keep track of fake or leave-based invites, and reward users who invite others. It's a powerful system for growing and moderating communities.

## ⚙️ Permissions Required

You must have either the `Administrator` or `Manage Server` (`ManageGuild`) permission to use these commands.

## ✨ Subcommands

### 🎚️ `/invitetracker toggle [enabled]`

Enables or disables the invite tracker.

* `enabled`: `True` to enable, `False` to disable.

### 🧪 `/invitetracker fake-treshold [treshold]`

Sets the threshold in days for account age. Invites from accounts newer than this will be flagged as **fake**.

* `treshold`: The minimum account age in **days**.

**Example:**

```sh theme={null}
/invitetracker fake-treshold 7
```

### 🧹 `/invitetracker reset-server-invites`

Resets all invite counts for all users in the server. **Use with caution.**

***

### 🎁 `/invitetracker add-bonus-invites <user> <invites>`

Adds bonus invites to a user or a role.

* `user`: A specific user or role.
* `invites`: Number of bonus invites to add.

**Example:**

```sh theme={null}
/invitetracker add-bonus-invites @User 5
```

### ➖ `/invitetracker remove-bonus-invites <user> <invites>`

Removes bonus invites from a user or a role.

***

### 🚫 `/invitetracker remove-fakes <user>`

Removes **fake invites** attributed to a user or role.

### 🚪 `/invitetracker remove-leaves <user>`

Removes **leave invites** attributed to a user or role (when people who were invited leave the server).

***

### 📄 `/invitetracker variables`

Displays all variables you can use in join and leave messages for invite logs.

You can also visit the [variables page](/variables#invite-tracker-variables) for more details.

***

### 📢 `/invitetracker logs [channel]`

Sets or displays the channel used for invite logging.

* `channel`: The target channel for invite logs.

***

### 📝 `/invitetracker edit-join-message`

Edit the message that appears when someone joins using an invite.

### 📝 `/invitetracker edit-leave-message`

Edit the message that appears when someone leaves the server.

### 📊 `/invites`

View your Total Invites, Bonus Invites and more in the server.

### 📃 `/invite-codes`

View all of your invite links in the server.

## 🔔 Notes

* The system tracks real, fake, and leave-based invites.
* Bonus invites can help you manually reward users without actual invites.
* Use [variables](/variables#invite-tracker-variables) in custom messages to show dynamic info like `{user}`, `{inviter}`, `{invites}`, etc.


# Auto Role
Source: https://docs.miona.bot/roles/auto-role

Automatically assign roles to new users and bots when they join your server.

The **Auto Role** feature allows you to automatically assign roles to members as soon as they join your server. This helps with onboarding, access control, and organizing your community more efficiently.

You can configure separate roles for **users** and **bots**, ensuring each type gets the appropriate permissions right from the start.

<Frame>
  <img alt="Example Auto Role" />
</Frame>

## ⚙️ Permissions Required

You must have the `Administrator` permission to use this command.

## ✨ Subcommands

### ➕ `/autorole add <role> [bots]`

Adds a role to the auto-role list.

* `role`: The role to assign automatically.
* `bots` (optional): Set to `True` if the role should be assigned to bots only. Leave blank or `False` for regular members.

**Examples:**

```sh theme={null}
/autorole add @Member
/autorole add @BotRole True
```

### ➖ `/autorole remove <role>`

Removes a role from the auto-role list.

```sh theme={null}
/autorole remove @Member
```

### 📜 `/autorole list`

Lists all roles currently set for auto assignment. Roles assigned to bots will be shown with a `[Bots]` suffix.

## 🧠 Notes

* You can assign multiple roles for both users and bots.
* Auto Role works immediately when a user or bot joins your server.
* Ensure the bot has permission to assign the roles listed in your auto-role settings.


# Mass Role
Source: https://docs.miona.bot/roles/mass-role

Add or remove a role from a member or a group of members at once.

The **Mass Role** command allows server administrators to quickly assign or remove a specific role from one member or multiple members at once. It's especially useful for managing large servers where manual role updates would be inefficient.

Whether you want to grant a role to everyone in a particular role or remove access from many users at once, this command simplifies the task.

## ⚙️ Permissions Required

You must have the `Administrator` permission to use this command.

## ℹ️ How to Use

To use the Mass Role command, simply type `/massrole` followed by the action you want to perform (add or remove), the target (user or role), and the role you want to assign or remove.
When you run the command for the first time you will be prompted to confirm your action.

<Frame>
  <img alt="Mass Role Confirmation" />
</Frame>

After that the bot will start the action.

<Frame>
  <img alt="Mass Role Action" />
</Frame>

When the action is finished, the bot will send a message in the channel where you ran the command.

<Frame>
  <img alt="Mass Role Finished" />
</Frame>

## ✨ Subcommands

### ➕ `/massrole add <mention> <role>`

Assigns the specified role to a single user or to all members who currently have a specific role.

* `mention`: A user or role mention.
* `role`: The role you want to assign.

**Examples:**

```sh theme={null}
/massrole add @User @Verified
/massrole add @Members @Event
```

### ➖ `/massrole remove <mention> <role>`

Removes the specified role from a single user or from all members of a specified role.

**Examples:**

```sh theme={null}
/massrole remove @User @Beta
/massrole remove @OldMembers @Tester
```

### ⏹️ `/massrole stop`

Stops a running mass-role action if one is in progress.

### 🔎 `/massrole status`

Displays the current status of any ongoing mass-role process.

## 🔔 Notes

* The command is powerful—use it carefully, especially when targeting large roles.
* Only one mass-role operation can run at a time.
* Mass-role actions may take some time to complete depending on server size.


# Reaction Roles
Source: https://docs.miona.bot/roles/reaction-roles

Let members assign themselves roles by reacting to messages.

**Reaction Roles** let you assign roles to members when they react to a specific message. It’s a great way to let users customize their experience or access different parts of your server—all with a simple emoji reaction.

This feature helps automate role management and encourages member engagement with minimal effort.

## ⚙️ Permissions Required

You must have the `Administrator` permission to use this command.

## ✨ Subcommands

### ➕ `/reactionroles add <message_url> <emoji> <role>`

Adds a reaction role to a message.

* `message_url`: Right-click the target message and "Copy Message Link"
* `emoji`: The emoji that will trigger the role assignment
* `role`: The role to assign when the emoji is used

**Example:**

```sh theme={null}
/reactionroles add https://discord.com/channels/... 🔥 @Gamer
```

### ➖ `/reactionroles remove <message_url> <emoji>`

Removes a reaction role from a message.

**Example:**

```sh theme={null}
/reactionroles remove https://discord.com/channels/... 🔥
```

### 📜 `/reactionroles list`

Lists all active reaction roles in your server.

## 🖱️ Quick Tip

You can also right-click a message, go to **Apps > Remove Reaction Role**, and remove it from there.

## 🧠 Notes

* The bot needs **Manage Roles** and **Read Message History** permissions in the target channel.
* Roles will only be given if the bot’s role is **above** the target role in the server role hierarchy.
* For help, use `/help` and look under the **Roles** category.


# Vanity Roles
Source: https://docs.miona.bot/roles/vanity-roles

Reward members who promote your server with custom roles.

**Vanity Roles** let you automatically assign roles to users who include your server's invite link (like `discord.gg/miona`) in their custom status. It's a powerful tool to reward those who help promote your community.

<Danger>
  This feature and its commands were powered by the Miona Vanity bot, which was officially shut down and deprecated on July 10, 2026. As a result, these commands are no longer available.

  For more information, please visit our [support server](https://discord.gg/52nsdaGpDx).
</Danger>

<Note>
  Although the public Miona Vanity bot has been shut down, you can still purchase your own private vanity bot through our [Patreon shop](https://www.patreon.com/mionabot/shop). Your private instance is independently hosted, so it won't be affected by the public vanity bot's shutdown.
</Note>

## 📝 Requirements to Access

* Your server must have **at least 14 Discord boosts**
* You must have a **vanity invite link** (e.g., `discord.gg/miona`)
* You must have [Miona Vanity](https://discord.com/oauth2/authorize?client_id=1280423090261725195) bot in your server

## ⚙️ Permissions Required

You must have the `Administrator` permission to use these commands.

## ✨ Subcommands

### 🔧 `/vanity setup <vanity> <role> [logs] [color]`

Initializes the Vanity Roles feature in your server.

* `vanity`: Your server's invite code (e.g., `/miona`)
* `role`: The role to assign to users who promote your server
* `logs`: *(Optional)* Channel to log vanity detections
* `color`: *(Optional)* Embed color in HEX (e.g., `#5865F2`)

**Example:**

```sh theme={null}
/vanity setup /miona @Promoter #logs #5865F2
```

### ➕ `/vanity add <vanity>`

Adds an additional vanity link to track.

**Example:**

```sh theme={null}
/vanity add miona
```

### ➖ `/vanity remove <vanity>`

Removes a tracked vanity link.

**Example:**

```sh theme={null}
/vanity remove /miona
```

### 📋 `/vanity list`

Lists all currently tracked vanity links in your server.

### ⛔ `/vanity stop`

Stops the Vanity Roles feature and untracks all links.

### 📢 `/vanity logs <channel>`

Sets the channel for logging vanity activity.

### 🎨 `/vanity color <color>`

Changes the color of the vanity role embed messages.

## 🧠 Notes

* The bot requires the **Manage Roles** and **Send Messages** permissions.
* The role to assign must be **below the bot’s role** in the server hierarchy.

Need assistance? [Join our support server](https://discord.gg/52nsdaGpDx) and open a ticket.


# Managing Categories
Source: https://docs.miona.bot/tickets/category

Create and assign ticket categories to panels for organized support.

Each ticket panel must have at least one assigned **category** to work properly. A category defines where the ticket channels will be created and helps keep your support system organized.

You can assign multiple categories to a single panel, giving users options to choose from when opening a ticket.

<Frame>
  <img alt="Example category panel" />
</Frame>

<Warning>
  Question Panels do not support categories.
</Warning>

## 🛠️ Adding a Ticket Category

To add a new category to a panel, use the command below:

```sh theme={null}
/tickets categories add <panel> <category>
```

After running this command, a form will appear where you can provide:

* **Name** of the category
* **Description**
* **Emoji**

Once submitted, the category will be added to the selected panel!

<Note>
  Need to display your panel? Use:

  ```sh theme={null}
  /tickets send-panel <panel> <channel>
  ```
</Note>

## ✏️ Editing a Ticket Category

To modify a category's details, run:

```sh theme={null}
/tickets categories edit <panel> <category>
```

## ❌ Removing a Ticket Category

To remove an existing category from a panel, use:

```sh theme={null}
/tickets categories remove <panel> <category>
```

## 📄 Listing All Categories

To view all categories assigned to a panel, run:

```sh theme={null}
/tickets categories list <panel>
```


# Creating a Panel
Source: https://docs.miona.bot/tickets/panel

Easily create and manage ticket panels and send them to a dedicated channel in your server.

Miona's ticket system is one of its most powerful features. It allows you to set up ticket panels with customizable [categories](/tickets/category), welcome messages, channel names, and more—all designed to match your server's unique style. With ticket panels, members can reach out for support, and you'll have a clean and structured way to assist them.

<Frame>
  <img alt="Example Ticket Panel" />
</Frame>

## 🛠️ How to Set Up a Panel

Start by creating a panel with the following command:

```sh theme={null}
/tickets create-panel <name> <type>
```

<Note>
  **Available Panel Types:**

  * Panel with Select Menu (Dropdown)
  * Panel with Buttons
  * [Panel with Questions](/tickets/questions)

  By default, you can create 1 panel. Upgrade to [premium](https://www.patreon.com/MionaBot) to create up to 3!
</Note>

Next, open the built-in panel editor:

```sh theme={null}
/tickets edit-panel <name>
```

This will let you customize the embed, text, and style of your panel.

<Tip>
  You can use [variables](/tickets/panel#what-variables-can-i-use) to personalize your messages.
</Tip>

<Frame>
  <img alt="Example Edit Panel" />
</Frame>

<Note>
  Some elements like the footer may require [premium](https://www.patreon.com/MionaBot) to edit.
</Note>

Once you're done customizing your panel:

1. Add at least one [category](/tickets/category).
2. Send the panel to a channel using:

```sh theme={null}
/tickets send-panel <name> <channel>
```

***

## ⚙️ Additional Panel Features

### 📨 How to Change the Welcome Message

Edit the message users see when they open a ticket:

```sh theme={null}
/tickets edit-welcome-message <panel>
```

<Frame>
  <img alt="Example Welcome Message" />
</Frame>

***

### 👥 Managing Access Roles

Access Roles are roles that can view and manage tickets in a panel. You can add or remove roles as needed.

**Add a role with access to tickets:**

```sh theme={null}
/tickets access-roles-add <panel> <role>
```

**Remove a role from ticket access:**

```sh theme={null}
/tickets access-roles-remove <panel> <role>
```

**List all access roles:**

```sh theme={null}
/tickets access-roles-list <panel>
```

***

### 🔔 Managing Ping Roles

Ping Roles are roles that will be notified when a ticket is created. You can add or remove roles as needed.

**Add a role to ping when a ticket is created:**

```sh theme={null}
/tickets ping-roles-add <panel> <role>
```

**Remove a ping role:**

```sh theme={null}
/tickets ping-roles-remove <panel> <role>
```

**List all ping roles:**

```sh theme={null}
/tickets ping-roles-list <panel>
```

***

### 🧾 Customizing Ticket Channel Names

Change the naming format for ticket channels:

```sh theme={null}
/tickets format <format>
```

***

### ⚙️ Global Ticket Settings

Change global settings that apply to all panels:

```sh theme={null}
/tickets settings
```

You'll be able to configure:

* Lock panel channel (Yes/No)
* Auto-delete ticket channel when closed (Yes/No)
* Save ticket transcripts (Yes/No)
* Confirm before closing tickets (Yes/No)
* Limit number of tickets per user (Server/Panel/Category/Unlimited)
* Set a log channel for ticket activity

<Frame>
  <img alt="Example Ticket Settings" />
</Frame>

***

### 📄 Ticket Logs Channel

Set the channel where ticket logs are sent:

```sh theme={null}
/tickets logs <channel>
```

***

### 🗑️ Deleting a Panel

Remove a panel with this command:

```sh theme={null}
/tickets delete-panel <name>
```

***

### 🧩 Using Variables

You can insert variables into most messages using the built-in editor. For a list of all available variables:

```sh theme={null}
/tickets variables
```

Or visit: [Variables Guide](/variables)


# Custom Questions
Source: https://docs.miona.bot/tickets/questions

Create ticket panels with custom questions.

## ✨ Overview

This feature allows you to create ticket panels that include **custom questions** users must answer before a ticket is created. Their responses will be included in the initial ticket message, providing context right from the start.

<Frame>
  <img alt="Example questions form" />
</Frame>

***

## 🎛️ Creating a Panel with Questions

To begin, you'll need to create a **Panel with Questions**. Only this panel type supports adding custom questions.

```sh theme={null}
/tickets create-panel <name> <type:Panel with questions>
```

Once created, you'll be prompted to:

* Choose a default category where the tickets will be created
* Add your custom questions

<Warning>
  Each panel can contain **1 to 5 questions**. At least **1 question** is required for the panel to function.
</Warning>

<Frame>
  <img alt="Example selecting default category" />
</Frame>

When prompted for default category, you have up to **5 minutes** to select a category channel where ticket channels will be created.
If you don't select a category within this time, the panel will be automatically deleted.

***

## 📤 Sending the Panel to a Channel

After setting up your panel and questions, make sure to send the panel to a specific channel so users can interact with it:

```sh theme={null}
/tickets send-panel <name> <channel>
```

<Note>
  Need help sending your panel? Check out the [Panel Setup Guide](/tickets/panel) for detailed instructions.
</Note>

<Frame>
  <img alt="Example questions created" />
</Frame>

***

## ⚙️ Managing Panel Questions

### ➕ Add a Question

To add a new question to your panel:

```sh theme={null}
/tickets questions add <panel>
```

<Warning>
  Each panel can contain **1 to 5 questions**. At least **1 question** is required for the panel to function.
</Warning>

***

### ➖ Remove a Question

To remove a specific question from a panel:

```sh theme={null}
/tickets questions remove <panel> <question>
```

***

### ✏️ Edit a Question

To modify an existing question:

```sh theme={null}
/tickets questions edit <panel> <question>
```

***

### 📋 List All Questions

To view all the questions currently assigned to a panel:

```sh theme={null}
/tickets questions list <panel>
```

***

✅ You're all set! Enjoy your fully customizable ticketing system.


# Variables
Source: https://docs.miona.bot/variables

How to use text variables when configuring Miona

Text variables are placeholders that automatically get replaced with specific information when a message is sent. These variables make it easy to personalize your messages without manually updating them each time. For example, instead of typing out the server's name, you can use `{server_name}`, and it will be replaced with the actual name of your server when the message is displayed.
Variables can also be scoped to the specific features, for example you can only use `{category_name}` in Ticket Welcome messages only.
You can find the list of variables by running:
`/variables`
or feature specific variables by running feature specific command like:
`/tickets variables`

## List of variables

### Member variables

These variables are available in messages where a member is involved:

* `{member_name}` - The member's name - ex. piton01
* `{member_display_name}` - The member's display name - ex. piton
* `{member_mention}` - The member's mention - ex. @piton
* `{member_avatar}` - The member's avatar URL
* `{member_banner}` - The member's banner URL
* `{member_created}` - When the member joined Discord - ex. 7/6/2017
* `{member_id}` - The member's ID - ex. 332434816601554945

### Server Variables

These variables can be used with all messages:

* `{server_name}` - The server's name - ex. miona | support server
* `{server_icon}` - The server's icon URL
* `{server_banner}` - The server's banner URL
* `{server_members}` - The number of members in the server - ex. 1113
* `{server_roles}` - The number of roles in the server - ex. 33
* `{server_channels}` - The number of channels in the server - ex. 59
* `{server_boosts}` - The number of boosts the server has - ex.24
* `{server_boost_level}` - The server's boost level - ex. 3
* `{server_boost_tier}` - The server's boost level - ex. 3
* `{server_created}` - When the server was created - ex. 6/15/2023

### Boooster Variables

These variables can be used within a boost message:

* `{booster_name}` - The booster's name - ex. piton01
* `{booster_mention}` - The booster's mention - ex. @piton
* `{booster_display_name}` - The booster's display name - ex. piton
* `{booster_avatar}` - The booster's avatar URL
* `{booster_banner}` - The booster's banner URL
* `{booster_created}` - When the booster joined Discord - ex. 7/6/2017
* `{booster_id}` - The booster's ID - ex. 332434816601554945
* `{boost_count}` - How many times the user has boosted - ex. 2

### Ticket Variables

Ticket variables can be used withing Ticket Welcome Messages `/tickets edit-welcome-message`

* `{category_name}` - The name of the category - ex. Support
* `{category_label}` - The name of the category - ex. Support
* `{category_description}` - The description of the category (Used with Select Menu Ticket Panels)

### Ticket Name Format Variables

These variables can be used when editing the Ticket name format `/tickets format`

* `{member_name}` - The name of the member - ex. piton01
* `{member_display_name}` - The display name of the member - ex. piton
* `{random}` - Four random numbers - ex. 1231
* `{random_emoji}` - Random emoji - ex. 🎉
* `{ticket_count}` - Ticket count for that category - ex. 10

### Voice Master Room Name Format Variables

These variables are used when editing the Voice Room name format `/voicemaster settings`

* `{member_name}` - The name of the member - ex. piton01
* `{member_display_name}` - The display name of the member - ex. piton
* `{random}` - Four random numbers - ex. 1231
* `{random_emoji}` - Random emoji - ex. 🎉

### Channel Variables

These variables can be used with sticky messages:

* `{channel_name}` - The name of the channel - ex. general
* `{channel_mention}` - The mention of the channel - ex. #general
* `{channel_id}` - The ID of the channel - ex. 332434816601554945
* `{channel_created}` - When the channel was created - ex. 7/6/2017

### Invite Tracker Variables

These variables are used to replace information about the inviter who invited the member in invites messages:

* `{inviter_name}` - The inviter's name - ex. piton01
* `{inviter_display_name}` - The inviter's display name - ex. piton
* `{inviter_mention}` - The inviter's mention - ex. @piton
* `{inviter_avatar}` - The inviter's avatar URL
* `{inviter_banner}` - The inviter's banner URL
* `{inviter_created}` - When the inviter joined Discord - ex. 7/6/2017
* `{inviter_id}` - The inviter's ID - ex. 332434816601554945
* `{inviter_invites}` - The number of invites the inviter has - ex. 12
* `{inviter_totalInvites}` - The number of invites the inviter has - ex. 12
* `{inviter_bonusInvites}` - The number of bonus invites the inviter has - ex. 0
* `{inviter_fakeInvites}` - The number of fake invites the inviter has - ex. 1
* `{inviter_leftInvites}` - The number of left invites the inviter has - ex. 3
* `{inviter_leaves}` - The number of left invites the inviter has - ex. 3
* `{invite_code}` - The invite code - ex. /miona
* `{invite_uses}` - The number of times the invite has been used - ex. 0

<Note>
  If you want to replace information about the member in invite messages, you can use the [Member Variables](#member-variables) from above.
</Note>

### Thread Variables

These variables can be used when configuring the Auto Thread feature:

* `{message_content}` - The content of the original message - ex. Hello World
* `{thread_name}` - The name of the thread - ex. general
* `{thread_mention}` - The mention of the thread - ex. #general
* `{thread_id}` - The ID of the thread - ex. 332434816601554945
* `{thread_created}` - When the thread was created - ex. 7/6/2017

<Warning>
  These variables can **ONLY** be used with the Auto Thread feature and its custom messages.
</Warning>

<Note>
  If you want to get the author of the original message, you can use the [Member Variables](#member-variables) from above.
</Note>

### General Variables

These variables can be used with all messages:

#### Current Time Variables

These variables insert the current time (when the message is sent / rendered):

* `{short_time}` - Current time in 24h HH:MM format - ex. 15:03
* `{short_date}` - Current date in M/D/YYYY format - ex. 8/21/2025
* `{short_date_time}` - Current date & time in D Mon YYYY HH:MM format - ex. 21 Aug 2025 15:03
* `{long_time}` - Current time in HH:MM:SS (24h) format - ex. 15:03:37
* `{long_date}` - Current date in Day Month YYYY (long with ordinal) - ex. 21st August 2025
* `{long_date_time}` - Current date & time with weekday - ex. Thursday, 21st August 2025 15:03
* `{relative_time}` - Relative time from now (human readable) - ex. a minute ago