> ## Documentation Index
> Fetch the complete documentation index at: https://docs.razebot.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Vanity URL Roles

> Automatically grant special vanity roles and send notifications when members feature your custom Discord vanity URL in their status.

# Vanity URL Roles

<Badge variant="pro">Tier 2: Pro</Badge>

> Incentivize members to promote your server by automatically awarding them an exclusive role whenever they put your Discord vanity link in their custom status/activity.

***

## Command Overview

| Command       | Aliases | Syntax                                 | Description                                            | Permissions   |
| :------------ | :------ | :------------------------------------- | :----------------------------------------------------- | :------------ |
| `.vanityrole` | `vrole` | `.vanityrole <subcommand> [arguments]` | Configure vanity role assignment and status detection. | Administrator |

***

## Subcommands Reference

| Subcommand    | Syntax                                         | Description                                            | Example                                                                           |
| :------------ | :--------------------------------------------- | :----------------------------------------------------- | :-------------------------------------------------------------------------------- |
| `set`         | `.vanityrole set <@role\|roleId> [vanitycode]` | Sets the reward role and optional vanity string        | `.vanityrole set @VanityRole raze`                                                |
| `channel`     | `.vanityrole channel <#channel\|channelId>`    | Sets the channel where vanity announcements are posted | `.vanityrole channel #vanity-logs`                                                |
| `message`     | `.vanityrole message <content>`                | Configures the thank-you message                       | `.vanityrole message Thanks {user} for using discord.gg/{vanity} in your status!` |
| `testmessage` | `.vanityrole testmessage`                      | Tests the configured vanity announcement               | `.vanityrole testmessage`                                                         |
| `config`      | `.vanityrole config`                           | Views current vanity role setup                        | `.vanityrole config`                                                              |
| `reset`       | `.vanityrole reset`                            | Clears all vanity role configurations                  | `.vanityrole reset`                                                               |

***

## Configuration Examples

<Tabs>
  <Tab title="Set Role & Vanity">
    ```bash theme={null} theme={null}
    .vanityrole set @VanitySupporter .gg/raze
    ```
  </Tab>

  <Tab title="Set Channel & Message">
    ```bash theme={null} theme={null}
    .vanityrole channel #general
    .vanityrole message Welcome to the VIP club {user}, thanks for supporting our vanity link!
    .vanityrole testmessage
    ```
  </Tab>

  <Tab title="Check Status">
    ```bash theme={null} theme={null}
    .vanityrole config
    ```
  </Tab>
</Tabs>