Server invites
Actions in the category "Server invites".
Create invite
Creates an invite for a channel.
Required permissions: Manage server.
Inputs
| Name | Type | Required | Details |
|---|---|---|---|
| Channel | Server channel | Yes | Channel the invite leads to. |
| Max age | Duration | Yes | How long the invite remains valid (0 = never expires). Value: 0 to 604800000. Default: 86400000. |
| Max uses | Whole number | Yes | How many times the invite may be used (0 = unlimited). Value: 0 to 100. Default: 0. |
| Temporary | Yes/No | Yes | Kick members on disconnect if they have no role. Default: No. |
| Unique | Yes/No | Yes | Always create a fresh code, never reuse an existing one. Default: No. |
Outputs
| Name | Type | Details |
|---|---|---|
| Invite | Invite | The created invite. |
Fetch vanity URL data
Look up the current vanity invite code and its use count.
Outputs
| Name | Type | Details |
|---|---|---|
| Vanity code | Text | The current vanity code, if any. May be empty. |
| Uses | Whole number | How many times the vanity code has been used. |
Delete invite
Revoke an existing invite link.
Required permissions: Manage server.
Inputs
| Name | Type | Required | Details |
|---|---|---|---|
| Invite | Invite | Yes | The invite to revoke. |
| Audit log reason | Text | No | Reason shown in the audit log. Maximum length: 512 characters. |
Outputs
| Name | Type | Details |
|---|---|---|
| Invite | Invite | The revoked invite. |
Fetch invite by code
Look up an invite by its code.
Inputs
| Name | Type | Required | Details |
|---|---|---|---|
| Code | Text | Yes | The invite code (the part after discord.gg/). |
| Include counts | Yes/No | No | Whether to include approximate member and presence counts. Default: No. |
| Include expiration | Yes/No | No | Whether to include the invite's expiration time. Default: No. |
Outputs
| Name | Type | Details |
|---|---|---|
| Invite | Invite | The invite, or empty if not found. May be empty. |
Fetch server invites
List all active invites in a server.
Required permissions: Manage server.
Outputs
| Name | Type | Details |
|---|---|---|
| Invites | List of Invite | All active invites. |
Fetch vanity invite
Look up the server's vanity invite, if it has one.
Required permissions: Manage server.
Outputs
| Name | Type | Details |
|---|---|---|
| Invite | Invite | The vanity invite, or empty. May be empty. |
Need more help?
Can't find what you're looking for? Our team is happy to help.