Soundboard Resource

Soundboard sounds are short audio clips that can be played in voice channels. There is a set of default sounds available to all users. Soundboard sounds can also be created in a guild; users will be able to use them in the guild, and premium (Nitro) subscribers can use them in all guilds.

Custom soundboard sounds in a can be retrieved over the Gateway using Request Soundboard Sounds.

Soundboard Sound Object

Soundboard Sound Structure

Field	Type	Description
sound_id	snowflake	The ID of the soundboard sound
name	string	The name of the soundboard sound (2-32 characters)
volume	float	The volume of the soundboard sound (represented as a float from 0 to 1)
emoji_id	?snowflake	The ID of the sound's custom emoji
emoji_name	?string	The unicode character of the sound's emoji
guild_id?	snowflake	The ID of the source guild
available?	boolean	Whether this guild sound can be used; may be false due to loss of premium subscriptions (boosts)
user_id	snowflake	The ID of the user who created this sound
user? ¹	partial user object	The user who created this sound

¹ Only included in contexts where the sound is created or updated.

Endpoints

Get Default Soundboard Sounds

GET/soundboard-default-sounds

Returns a list of soundboard sound objects that can be used by all users.

Create Guild Soundboard Sound

POST/guilds/{guild.id}/soundboard-sounds

Audit Log Reason

Creates a new soundboard sound for the guild. Requires the MANAGE_GUILD_EXPRESSIONS permission. Returns the new soundboard sound object on success. Fires a Guild Soundboard Sound Create Gateway event.

JSON Params

Field	Type	Description
name	string	The name of the soundboard sound (2-32 characters)
sound	sound data	The sound file to upload
volume?	?float	The volume of the soundboard sound (represented as a float from 0 to 1, default 1)
emoji_id?	?snowflake	The ID of the sound's custom emoji
emoji_name?	?string	The unicode character of the sound's emoji

Modify Guild Soundboard Sound

PATCH/guilds/{guild.id}/soundboard-sounds/{sound.id}

Audit Log Reason

Replaces the given soundboard sound. Requires the MANAGE_GUILD_EXPRESSIONS permission. Returns the updated soundboard sound object on success. Fires a Guild Soundboard Sound Update Gateway event.

JSON Params

Field	Type	Description
name?	?string	The name of the soundboard sound (2-32 characters)
volume?	?float	The volume of the soundboard sound (represented as a float from 0 to 1, default 1)
emoji_id?	?snowflake	The ID of the sound's custom emoji
emoji_name?	?string	The unicode character of the sound's emoji

Delete Guild Soundboard Sound

DELETE/guilds/{guild.id}/soundboard-sounds/{sound.id}

Audit Log Reason

Deletes the given soundboard sound. Requires the MANAGE_GUILD_EXPRESSIONS permission. Returns a 204 empty response on success. Fires a Guild Soundboard Sound Delete Gateway event.

Send Soundboard Sound

POST/channels/{channel.id}/send-soundboard-sound

Sends a soundboard sound to a voice channel. Returns a 204 empty response on success. Fires a Voice Channel Effect Send Gateway event.

JSON Params

Field	Type	Description
sound_id	snowflake	The ID of the soundboard sound to send
source_guild_id?	?snowflake	The ID of the sound's source guild, if applicable (not required)