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

# Vanity Message

> Announce members who start showing your invite in their status.

```text theme={null}
/config channel vanity-channel #vanity
/config vanity message "hey {user}, you're repping {server} now · thanks!"
```

Default text matches that example. The announcement is optional · the role is granted either way.

## When it sends

* A member's custom status starts containing the configured keyword (or the server's vanity URL when
  no keyword is set), and the vanity role is granted.
* Announcements are rate-limited **per member** by `vanity-cooldown`, one hour by default, so
  flipping a status on and off doesn't spam the channel.

## Placeholders

| Token | Output |
| - | - |
| `{user}` | The member |
| `{server}` | Server name |
| `{guild.member_count}` | Member count |

## Related settings

| Setting | Purpose |
| - | - |
| `vanity-role` | Role granted while the invite is shown |
| `vanity-keyword` | Text to match · falls back to the vanity URL |
| `vanity-channel` | Where announcements post · empty means no message |
| `vanity-cooldown` | Seconds between announcements for one member |

Detection rules, rescan and the member list live on [Vanity roles](https://docs.criminal.work/features/roles/vanity.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.