# Vanity Roles

Elyxir has a fully customisable Vanity Roles feature which promotes your server to a new audience while providing loyalty rewards to your members!

#### OBJECTIVES

* [Configure the Vanity Roles Module](#setup)
* [Customise the embeds to suit your server](#notification-mesage)

<figure><img src="/files/hgx95fiC5tgP9t4SMK5B" alt=""><figcaption></figcaption></figure>

#### REQUIREMENTS

**Premium Tier** and **Deluxe Tier** subscriptions have full functionality access to this feature.

## Setup&#x20;

To set up this feature, you need to run the [`/vanityroles setup`](/commands/vanityroles/setup.md) command. You need to provide all of the parameters

{% hint style="success" %}
You can change the configuration for this module at any time using the [`/vanityroles`](/features/vanity-roles.md) subcommands.
{% endhint %}

## Customisation

We now have custom configuration commands which allows you to change individual settings without changing all of them, which all have the [`/vanityroles`](/commands/vanityroles.md) parent command.

#### Notification Text

You can change the notification messages by using the [`/vanityroles embed`](/commands/vanityroles/embed.md) command, which allows you to change the content (for example to stop the bot mentioning users) as well as other embed properties. You can use any of the parameters listed below in the fields.

<figure><img src="/files/ZmAuzLQRlS0GutbAZoYw" alt=""><figcaption></figcaption></figure>

{% code lineNumbers="true" %}

```
{member.mention} - Mention the user who changed their status
{member.tag}     - The username of the member in format User#0000
{member.id}      - The user id who changed their status
{guild.name}     - The server name where the event was triggered
{guild.id}       - The server id where the event was triggered
{vanityURL}      - The vanity URL for your server
```

{% endcode %}

#### Notification Type

You can also choose where to send the message. This is called the `Notification Type`  and can be changed using the [`/vanityroles notification`](/commands/vanityroles/notification.md) .

#### Vanity URL

Changing the VanityURL for your server is easy! Simply use the [`/vanityroles url`](/commands/vanityroles/url.md) command and type your vanity URL.&#x20;

{% hint style="success" %}
The URL command modifies your URL automatically to ensure that common aliases are allowed for in statuses, for example *.gg/elyxir* *is accepted when the URL is discord.gg/elyxir*
{% endhint %}

#### Embed Colour

The embed colour is determined by the branding colour, so it is only possible to change this if you use a [**Custom Bot** ](/features/custom-instances.md)which requires the **Deluxe Tier.** You can change this using the [`/branding colour`](/commands/branding/colour.md) command.

#### Vanity Channel

To change the Notification Channel, which will only be used if your notification type is set to `Log Channel`, just run the [`/vanityroles channel`](/commands/vanityroles/channel.md) command and select the correct channel.

#### Vanity Role

To change the role applied to vanity supporters, the [`/vanityroles role`](/commands/vanityroles/role.md) command will allow you to select a new role.

<figure><img src="/files/JNrQUKr9bYWL5I6dmtWG" alt=""><figcaption><p><a href="https://zap-hosting.com/deluxe"><strong>Click here to be redirected to our affiliate link!</strong></a></p></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.elyxir.dev/features/vanity-roles.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.