Passa al contenuto principale

Server settings

Update your server's name, icon, verification level and other settings.

Edit server settings​

Edits server-wide settings.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
NameTextNoNew server name. Length: 2 to 100 characters.
Verification levelVerification levelNoRequired verification level for new members.
Content filterExplicit content filterNoExplicit content filter setting.
Default notificationsDefault notificationsNoDefault notification setting.
Preferred localeTextNoServer-preferred locale.
Audit log reasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Fetch audit log entries​

Fetches recent entries from the audit log.

Required permissions: View audit log.

Inputs

NameTypeRequiredDetails
LimitWhole numberYesMaximum number of entries to fetch (1 - 100). Value: 1 to 100. Default: 50.
ActionAudit log eventNoOnly return entries with this action.
ExecutorUserNoOnly return entries performed by this user.

Outputs

NameTypeDetails
EntriesList of Audit log entryAudit log entries that match the filter.

Set server name​

Update the display name of a server.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
NameTextYesThe new server name (2-100 characters). Length: 2 to 100 characters.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set server icon​

Change or remove the server icon.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
Icon URLURLYesURL to the new icon image, or empty to remove.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set server banner​

Change or remove the server banner.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
Banner URLURLYesURL to the new banner image, or empty to remove.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set invite splash​

Change or remove the invite splash image shown on invite links.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
Splash URLURLYesURL to the new splash image, or empty to remove.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set discovery splash​

Change or remove the splash image shown in the discovery directory.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
Discovery splash URLURLYesURL to the new discovery splash image, or empty to remove.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set system channel​

Pick the channel where system messages (joins, boosts) are posted.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
System channelText channelYesThe text channel for system messages, or empty to disable.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set system channel flags​

Configure which system messages are suppressed in the system channel.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
FlagsList of System channel flagYesFlags identifying which system messages to suppress.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set AFK channel​

Pick the voice channel users are moved to when idle.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
AFK channelVoice channelYesThe voice channel for idle members, or empty to disable.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set AFK timeout​

Set how long until idle voice members are moved to the AFK channel.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
TimeoutDurationYesThe AFK timeout (60s, 5m, 15m, 30m, or 1h). Allowed values: 60, 300, 900, 1800, 3600.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set rules channel​

Designate the channel that displays the server's rules (community servers only).

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
Rules channelText channelYesThe text channel containing the rules.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set public updates channel​

Designate the channel that receives Discord community updates (community servers only).

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
Public updates channelText channelYesThe text channel for Discord community updates.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set safety alerts channel​

Pick the channel that receives Discord safety notifications.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
Safety alerts channelText channelYesThe text channel for safety alerts.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set verification level​

Adjust how strict the server's verification requirement is for new members.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
Verification levelVerification levelYesThe new verification level.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set explicit content filter​

Configure how Discord scans uploaded media for explicit content.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
FilterExplicit content filterYesThe explicit content filter level.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set default notifications​

Configure whether members get notified for all messages or only mentions by default.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
Notifications levelDefault notificationsYesThe new default notification level.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set MFA level​

Require two-factor authentication for moderators (server owner only).

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
MFA levelTwo-factor requirementYesThe new MFA requirement.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set vanity URL​

Set or clear the server's vanity invite code (boost level 3 required).

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
Vanity codeTextYesThe new vanity code (2-32 chars), or empty to clear. Length: 2 to 32 characters.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Set preferred locale​

Set the server's preferred locale used for system messages.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
LocaleTextYesAn ISO locale identifier such as en-US.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Transfer server ownership​

Transfer ownership of the server to another member. The bot must own the server and have MFA enabled.

Inputs

NameTypeRequiredDetails
New ownerServer memberYesThe member who will become the new owner.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ServerServerThe updated server.

Leave server​

Remove the bot from a server.

Fetch server preview​

Get a public preview of a discoverable server.

Outputs

NameTypeDetails
PreviewServer previewThe discoverable server preview.

Fetch widget settings​

Read the server widget enable state and target channel.

Required permissions: Manage server.

Outputs

NameTypeDetails
EnabledYes/NoWhether the widget is enabled.
ChannelServer channelThe channel the widget invite points to. May be empty.

Update widget settings​

Enable or disable the server widget and pick its invite channel.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
EnabledYes/NoYesWhether the widget is enabled.
ChannelServer channelNoThe channel the widget invite should point to.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
EnabledYes/NoWhether the widget is now enabled.
ChannelServer channelThe new widget invite channel. May be empty.

Fetch server templates​

List all server templates created from a server.

Required permissions: Manage server.

Outputs

NameTypeDetails
TemplatesList of Server templateAll templates of the server.

Create server template​

Snapshot the server's structure into a new template.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
NameTextYesThe template name. Length: 1 to 100 characters.
DescriptionTextNoA short template description. Maximum length: 120 characters.

Outputs

NameTypeDetails
TemplateServer templateThe created template.

Update server template​

Edit a template's name and description.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
TemplateServer templateYesThe template to update.
NameTextNoThe new name. Length: 1 to 100 characters.
DescriptionTextNoThe new description. Maximum length: 120 characters.

Outputs

NameTypeDetails
TemplateServer templateThe updated template.

Delete server template​

Permanently delete a server template.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
TemplateServer templateYesThe template to delete.

Outputs

NameTypeDetails
TemplateServer templateThe deleted template.

Sync server template​

Refresh the template's snapshot from its source server.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
TemplateServer templateYesThe template to sync.

Outputs

NameTypeDetails
TemplateServer templateThe synced template.

Fetch integrations​

List all integrations installed in a server.

Required permissions: Manage server.

Outputs

NameTypeDetails
IntegrationsList of Server integrationAll integrations in the server.

Delete integration​

Remove an integration from a server.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
IntegrationServer integrationYesThe integration to remove.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Create soundboard sound​

Upload a new soundboard sound to a server.

Required permissions: Manage expressions.

Inputs

NameTypeRequiredDetails
NameTextYesThe sound name (2-32 chars). Length: 2 to 32 characters.
Sound file URLURLYesURL of the audio file (MP3 or OGG; max 512KB, up to 5.2 seconds).
VolumeDecimal numberNoPlayback volume between 0.0 and 1.0. Value: 0 to 1. Default: 1.
Emoji nameTextNoUnicode emoji shown beside the sound.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
SoundSoundboard soundThe created soundboard sound.

Update soundboard sound​

Edit a soundboard sound's name, volume, or emoji.

Required permissions: Manage expressions.

Inputs

NameTypeRequiredDetails
SoundSoundboard soundYesThe sound to update.
NameTextNoThe new sound name. Length: 2 to 32 characters.
VolumeDecimal numberNoThe new playback volume. Value: 0 to 1.
EmojiTextNoThe new associated emoji.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
SoundSoundboard soundThe updated sound.

Delete soundboard sound​

Permanently delete a soundboard sound.

Required permissions: Manage expressions.

Inputs

NameTypeRequiredDetails
SoundSoundboard soundYesThe sound to delete.
Audit log reasonTextNoReason shown in the audit log. Maximum length: 512 characters.

Play soundboard sound​

Play a soundboard sound in a voice channel the bot has joined.

Inputs

NameTypeRequiredDetails
Voice channelVoice channelYesThe voice channel to play the sound in.
SoundSoundboard soundYesThe soundboard sound to play.

Fetch soundboard sounds​

List all soundboard sounds in a server.

Outputs

NameTypeDetails
SoundsList of Soundboard soundAll soundboard sounds in the server.

Fetch default soundboard sounds​

List Discord's default soundboard sounds available everywhere.

Outputs

NameTypeDetails
SoundsList of Soundboard soundDiscord's default soundboard sounds.

Fetch welcome screen​

Loads the welcome screen configuration of a server.

Outputs

NameTypeDetails
Welcome ScreenWelcome screenThe fetched welcome screen.

Update welcome screen​

Updates the welcome screen of a server. Requires the MANAGE_GUILD permission.

Required permissions: Manage server.

Inputs

NameTypeRequiredDetails
EnabledYes/NoNoWhether the welcome screen should be enabled.
DescriptionTextNoNew welcome-screen description (max 140 characters). Maximum length: 140 characters.
Welcome ChannelsList of Welcome screen channelNoUp to five highlighted channels. Maximum items: 5.
Audit Log ReasonTextNoReason recorded in the audit log (max 512 characters). Maximum length: 512 characters.

Outputs

NameTypeDetails
Welcome ScreenWelcome screenThe updated welcome screen.

Fetch server onboarding​

Loads the onboarding configuration of a server.

Outputs

NameTypeDetails
OnboardingServer onboardingThe fetched onboarding configuration.

Update server onboarding​

Updates the onboarding configuration of a server. Requires MANAGE_GUILD and MANAGE_ROLES.

Required permissions: Manage server, Manage roles.

Inputs

NameTypeRequiredDetails
PromptsList of Onboarding promptYesOnboarding prompts shown to new members.
Default Channel IDsList of Discord IDYesChannels visible to every member by default.
EnabledYes/NoYesWhether onboarding should be enabled.
ModeOnboarding modeYesWhether to count only default channels or also prompt channels toward onboarding constraints.
Audit Log ReasonTextNoReason recorded in the audit log (max 512 characters). Maximum length: 512 characters.

Outputs

NameTypeDetails
OnboardingServer onboardingThe updated onboarding configuration.

Fetch widget image URL​

Returns the URL of the server's widget image in the requested style.

Inputs

NameTypeRequiredDetails
StyleWidget image styleYesHow the widget image looks. Default: Shield.

Outputs

NameTypeDetails
URLURLURL pointing to the rendered widget image.

Fetch server template by code​

Fetches a server template by its public code.

Inputs

NameTypeRequiredDetails
Template codeTextYesPublic template code (the part after discord.new/). Length: 1 to 32 characters.

Outputs

NameTypeDetails
TemplateServer templateThe fetched template, or empty. May be empty.

Get server​

Reads details of the current server.

Outputs

NameTypeDetails
ServerServerThe current server.
Need more help?
Can't find what you're looking for? Our team is happy to help.