Skip to content

Latest commit

 

History

History
169 lines (122 loc) · 11.5 KB

Sticker.md

File metadata and controls

169 lines (122 loc) · 11.5 KB

Sticker Resource

Sticker Object

Represents a sticker that can be sent in messages.

Sticker Structure
Field Type Description
id snowflake id of the sticker
pack_id? snowflake for standard stickers, id of the pack the sticker is from
name string name of the sticker
description ?string description of the sticker
tags* string autocomplete/suggestion tags for the sticker (max 200 characters)
asset? string Deprecated previously the sticker asset hash, now an empty string
type integer type of sticker
format_type integer type of sticker format
available? boolean whether this guild sticker can be used, may be false due to loss of Server Boosts
guild_id? snowflake id of the guild that owns this sticker
user? user object the user that uploaded the guild sticker
sort_value? integer the standard sticker's sort order within its pack

* 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
Type Value Description
STANDARD 1 an official sticker in a pack, part of Nitro or in a removed purchasable pack
GUILD 2 a sticker uploaded to a guild for the guild's members
Sticker Format Types
Type Value
PNG 1
APNG 2
LOTTIE 3
GIF 4
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 id of the sticker
name string name of the sticker
format_type integer type of sticker format

Sticker Pack Object

Represents a pack of standard stickers.

Sticker Pack Structure
Field Type Description
id snowflake id of the sticker pack
stickers array of sticker objects the stickers in the pack
name string name of the sticker pack
sku_id snowflake id of the pack's SKU
cover_sticker_id? snowflake id of a sticker in the pack which is shown as the pack's icon
description string description of the sticker pack
banner_asset_id? snowflake 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"
}

Get Sticker % GET /stickers/{sticker.id#DOCS_RESOURCES_STICKER/sticker-object}

Returns a sticker object for the given sticker ID.

List Nitro Sticker Packs % GET /sticker-packs

Returns the list of sticker packs available to Nitro subscribers.

Response Structure
Field Type
sticker_packs array of sticker pack objects

List Guild Stickers % GET /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/stickers

Returns an array of sticker objects for the given guild. Includes user fields if the bot has the MANAGE_GUILD_EXPRESSIONS permission.

Get Guild Sticker % GET /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/stickers/{sticker.id#DOCS_RESOURCES_STICKER/sticker-object}

Returns a sticker object for the given guild and sticker IDs. Includes the user field if the bot has the MANAGE_GUILD_EXPRESSIONS permission.

Create Guild Sticker % POST /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/stickers

Create a new sticker for the guild. Send a multipart/form-data body. Requires the MANAGE_GUILD_EXPRESSIONS 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 Boost level will grant access to more slots.

info This endpoint supports the X-Audit-Log-Reason header.

warn Lottie stickers can only be uploaded on guilds that have either the VERIFIED and/or the PARTNERED guild feature.

warn Uploaded stickers are constrained to 5 seconds in length for animated stickers, and 320 x 320 pixels.

Form Params
Field Type Description
name string name of the sticker (2-30 characters)
description string description of the sticker (empty or 2-100 characters)
tags string autocomplete/suggestion tags for the sticker (max 200 characters)
file file contents the sticker file to upload, must be a PNG, APNG, GIF, or Lottie JSON file, max 512 KB

Modify Guild Sticker % PATCH /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/stickers/{sticker.id#DOCS_RESOURCES_STICKER/sticker-object}

Modify the given sticker. Requires the MANAGE_GUILD_EXPRESSIONS permission. Returns the updated sticker object on success. Fires a Guild Stickers Update Gateway event.

info All parameters to this endpoint are optional.

info This endpoint supports the X-Audit-Log-Reason header.

JSON Params
Field Type Description
name string name of the sticker (2-30 characters)
description ?string description of the sticker (2-100 characters)
tags string autocomplete/suggestion tags for the sticker (max 200 characters)

Delete Guild Sticker % DELETE /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/stickers/{sticker.id#DOCS_RESOURCES_STICKER/sticker-object}

Delete the given sticker. Requires the MANAGE_GUILD_EXPRESSIONS permission. Returns 204 No Content on success. Fires a Guild Stickers Update Gateway event.

info This endpoint supports the X-Audit-Log-Reason header.