guild_get_vanity_url
guild_get_vanity_url
Section titled “guild_get_vanity_url”Category: guild
Get the guild vanity URL invite (Community/Partner perk).
When to use
Section titled “When to use”- Display the configured
discord.gg/\<code>shortcut and how many times it has been used.
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild to query |
Returns
Section titled “Returns”\{code, uses\}. code is null if no vanity URL is configured.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
code | unknown | yes | |
uses | integer | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |