Sticker Resource
Stickers are embedded images that can be sent along with messages. They can be either standard stickers, which are official, first-party stickers, or guild stickers, which are custom stickers uploaded by users in a guild.
Sticker Pack Object
A pack of standard stickers.
Sticker Pack Structure
Field | Type | Description |
---|---|---|
id | snowflake | The ID of the sticker pack |
stickers | array[sticker object] | The stickers in the pack |
name | string | The name of the sticker pack |
sku_id | snowflake | The ID of the pack's SKU |
cover_sticker_id? | snowflake | The ID of a sticker in the pack which is shown as the pack's icon |
description | string | The description for the sticker pack |
banner_asset_id? | snowflake | The ID of the sticker pack's banner image |
Example Sticker Pack
{"id": "847199849233514549","stickers": [],"name": "Wumpus Beyond","sku_id": "847199849233514547","cover_sticker_id": "749053689419006003","description": "Say hello to Wumpus!","banner_asset_id": "761773777976819732"}
Sticker Object
A sticker that can be sent in messages.
Sticker Structure
Field | Type | Description |
---|---|---|
id | snowflake | The ID of the sticker |
pack_id? | snowflake | For standard stickers, ID of the pack the sticker is from |
name | string | The name of the sticker (2-30 characters) |
description | ?string | The description for the sticker (max 100 characters) |
tags 2 | string | Autocomplete/suggestion tags for the sticker (1-200 characters) |
type | integer | The type of sticker |
format_type | integer | The type of format for the sticker |
available? | boolean | Whether this guild sticker can be used; may be false due to loss of premium subscriptions (boosts) |
guild_id? | snowflake | The ID of the guild the sticker is attached to |
user? 1 | partial user object | The user that uploaded the guild sticker |
sort_value? | integer | The standard sticker's sort order within its pack |
1 Only included for guild stickers when fetched through the Get Guild Stickers or Get Guild Sticker endpoints by a user with the MANAGE_EMOJIS_AND_STICKERS
permission.
2 A comma separated list of keywords is the format used in this field by standard stickers, but this is just a convention. Incidentally the client will always use a name generated from an emoji as the value of this field when creating or modifying a guild sticker.
Sticker Types
Value | Name | Description |
---|---|---|
1 | STANDARD | An official sticker in a current or legacy purchasable pack |
2 | GUILD | A sticker uploaded to a guild for the guild's members |
Sticker Format Types
Value | Name | Description |
---|---|---|
1 | PNG | A PNG image |
2 | APNG | An animated PNG image, using the APNG format |
3 | LOTTIE | A lottie animation; requires the VERIFIED and/or PARTNERED guild feature |
4 | GIF | An animated GIF image |
Example Sticker
{"id": "749054660769218631","name": "Wave","tags": "wumpus, hello, sup, hi, oi, heyo, heya, yo, greetings, greet, welcome, wave, :wave, :hello, :hi, :hey, hey, \ud83d\udc4b, \ud83d\udc4b\ud83c\udffb, \ud83d\udc4b\ud83c\udffc, \ud83d\udc4b\ud83c\udffd, \ud83d\udc4b\ud83c\udffe, \ud83d\udc4b\ud83c\udfff, goodbye, bye, see ya, later, laterz, cya","type": 1,"format_type": 3,"description": "Wumpus waves hello","asset": "","pack_id": "847199849233514549","sort_value": 12}
Sticker Item Object
The smallest amount of data required to render a sticker. A partial sticker object.
Sticker Item Structure
Field | Type | Description |
---|---|---|
id | snowflake | The ID of the sticker |
name | string | The name of the sticker |
format_type | integer | The type of format for the sticker |
Endpoints
Get Sticker Packs
GET
/sticker-packs
Returns the list of sticker packs available to use.
Response Body
Field | Type | Description |
---|---|---|
sticker_packs | array[sticker pack object] | The sticker packs available |
Get Sticker Pack
GET
/sticker-packs/{pack.id}
Returns a sticker pack object for the given pack ID.
Get Sticker
GET
/stickers/{sticker.id}
Returns a sticker object for the given sticker ID.
Get Sticker Guild
GET
/stickers/{sticker.id}/guild
Returns a discoverable guild object for the guild that owns the given sticker. This endpoint requires the guild to be discoverable and have emoji/sticker discoverability enabled.
Get Guild Stickers
GET
/guilds/{guild.id}/stickers
Returns an array of sticker objects for the given guild. Includes user
fields if the user has the MANAGE_EMOJIS_AND_STICKERS
permission.
Get Guild Sticker
GET
/guilds/{guild.id}/stickers/{sticker.id}
Returns a sticker object for the given guild and sticker IDs. Includes the user
field if the user has the MANAGE_EMOJIS_AND_STICKERS
permission.
Create Guild Sticker
POST
/guilds/{guild.id}/stickers
Creates a new sticker for the guild. Send a multipart/form-data
body. Requires the MANAGE_EMOJIS_AND_STICKERS
permission. Returns the new sticker object on success. Fires a Guild Stickers Update Gateway event.
Every guilds has five free sticker slots by default, and each premium tier (boost level) will grant access to more slots.
Form Params
Field | Type | Description |
---|---|---|
name | string | The name of the sticker (2-30 characters) |
description | string | The description for the sticker (max 100 characters) |
tags | string | Autocomplete/suggestion tags for the sticker (1-200 characters) |
file | file contents | The sticker file to upload, must be a PNG, APNG, GIF, or Lottie JSON file |
Modify Guild Sticker
PATCH
/guilds/{guild.id}/stickers/{sticker.id}
Modifies the given sticker. Requires the MANAGE_EMOJIS_AND_STICKERS
permission. Returns the updated sticker object on success. Fires a Guild Stickers Update Gateway event.
JSON Params
Field | Type | Description |
---|---|---|
name | string | The name of the sticker (2-30 characters) |
description | ?string | The description for the sticker (max 100 characters) |
tags | string | Autocomplete/suggestion tags for the sticker (1-200 characters) |
Delete Guild Sticker
DELETE
/guilds/{guild.id}/stickers/{sticker.id}
Deletes the given sticker. Requires the MANAGE_EMOJIS_AND_STICKERS
permission. Returns a 204 empty response on success. Fires a Guild Stickers Update Gateway event.