Skip to content
Fluxer API

Guild stickers

A sticker is an image a guild stores for its members to send with a message. Names, descriptions, tags and images must pass the instance's content policy, and blocked content returns CONTENT_BLOCKED. To look up a sticker without being in its guild, see Get sticker metadata.

Guild sticker object

Section titled “Guild sticker object”

Structure

Section titled “Structure”
FieldTypeDescription
idsnowflakeThe ID of the sticker
namestringThe name of the sticker (2-30 characters)
descriptionstringThe sticker description, or an empty string when it has none
tagsarray[string]The sticker tags
animatedbooleanWhether the image is animated
user?partial user objectThe account that uploaded the sticker, only on List guild stickers

Example

Section titled “Example”
{
  "id": "1501314428688998183",
  "name": "shipit",
  "description": "Ship it",
  "tags": ["ship", "deploy"],
  "animated": false
}

Sticker create object

Section titled “Sticker create object”

The body of Create guild sticker and each entry of Bulk create guild stickers.

Structure

Section titled “Structure”
FieldTypeDescription
namestringThe name of the sticker (2-30 characters)
description??stringThe sticker description (1-500 characters)
tags?array[string]The sticker tags (at most 10, 1-30 characters each)
imagebase64 stringThe image data, up to the sticker_max_size limit (524288 bytes by default)

Fluxer accepts PNG, JPEG, APNG, GIF, WebP, AVIF and SVG as base64 or a data URL, but not animated AVIF. A larger image returns IMAGE_SIZE_EXCEEDS_LIMIT, and an image in another format or one Fluxer can't decode returns INVALID_IMAGE_FORMAT.

Sticker bulk create response object

Section titled “Sticker bulk create response object”

The outcome of one Bulk create guild stickers call.

Structure

Section titled “Structure”
FieldTypeDescription
successarray[guild sticker object]The stickers that were created
failedarray[sticker creation failure object]The items that were rejected

Sticker creation failure object

Section titled “Sticker creation failure object”

One rejected item from a bulk create call.

Structure

Section titled “Structure”
FieldTypeDescription
namestringThe requested sticker name
errorstringThe failure message, in the language of the account that sent the request

List guild stickers

Section titled “List guild stickers”
GET/v1/guilds/{guild_id}/stickersBot

Returns the guild's stickers. You need to be a member of the guild.

Response

Section titled “Response”
StatusBodyCondition
200array[guild sticker object]The stickers were returned

The rate limit is 60 requests per 10 seconds, on the guild:sticker:list::guild_id bucket.

Create guild sticker

Section titled “Create guild sticker”
POST/v1/guilds/{guild_id}/stickersBotAudit reason

Creates a sticker and returns it. You need CREATE_EXPRESSIONS. Fluxer sends a Guild Stickers Update event.

A guild can have 500 stickers by default, set by the max_guild_stickers limit key, and UNLIMITED_STICKERS raises it to 999999.

JSON body

Section titled “JSON body”

The body is one sticker create object.

Response

Section titled “Response”
StatusBodyCondition
200guild sticker objectThe sticker was created
400error responseMAX_STICKERS when the guild is at its sticker limit, or a field or the image is invalid

The rate limit is 10 requests per 30 seconds, on the guild:sticker:create::guild_id bucket.

Bulk create guild stickers

Section titled “Bulk create guild stickers”
POST/v1/guilds/{guild_id}/stickers/bulkBotAudit reason

Creates several stickers in one request and returns a sticker bulk create response object. You need CREATE_EXPRESSIONS. Fluxer sends one Guild Stickers Update event when at least one sticker was created.

Fluxer creates the items in order, and each one succeeds or fails on its own. The request returns 200 even when every item fails, and failed lists the items that weren't created.

JSON body

Section titled “JSON body”
FieldTypeDescription
stickersarray[sticker create object]The stickers to create (1-50)

Response

Section titled “Response”
StatusBodyCondition
200sticker bulk create response objectEvery item was attempted
400error responseThe body, the item count or any item's fields fail validation

The rate limit is 6 requests per minute, on the guild:sticker:bulk_create::guild_id bucket.

Clone guild sticker

Section titled “Clone guild sticker”
POST/v1/guilds/{guild_id}/stickers/cloneBotAudit reason

Copies a sticker from any guild into this guild and returns it. You need CREATE_EXPRESSIONS in this guild, and you don't need to be a member of the source guild. The source guild needs CLONE_STICKER_ENABLED. Fluxer sends a Guild Stickers Update event in the target guild.

JSON body

Section titled “JSON body”
FieldTypeDescription
source_sticker_idsnowflakeThe ID of the sticker to copy

Response

Section titled “Response”
StatusBodyCondition
200guild sticker objectThe sticker was cloned
400error responseMAX_STICKERS when the target guild is at its sticker limit
403error responseMISSING_ACCESS when the source guild is gone or doesn't allow cloning
404error responseUNKNOWN_STICKER when the source sticker doesn't exist

The rate limit is 10 requests per 30 seconds, on the guild:sticker:clone::guild_id bucket.

Modify guild sticker

Section titled “Modify guild sticker”
PATCH/v1/guilds/{guild_id}/stickers/{sticker_id}BotAudit reason

Updates the name, description and tags of a sticker and returns it. To replace the image, create a new sticker. The uploader needs CREATE_EXPRESSIONS and anyone else needs MANAGE_EXPRESSIONS. Fluxer sends a Guild Stickers Update event.

JSON body

Section titled “JSON body”
FieldTypeDescription
namestringThe name of the sticker (2-30 characters)
description??stringThe sticker description (1-500 characters)
tags?array[string]The sticker tags (at most 10, 1-30 characters each)

Response

Section titled “Response”
StatusBodyCondition
200guild sticker objectThe sticker was updated
404error responseUNKNOWN_STICKER when the sticker isn't in the guild

The rate limit is 20 requests per 10 seconds, on the guild:sticker:update::guild_id bucket.

Delete guild sticker

Section titled “Delete guild sticker”
DELETE/v1/guilds/{guild_id}/stickers/{sticker_id}BotAudit reason

Deletes a sticker and returns 204. The uploader needs CREATE_EXPRESSIONS and anyone else needs MANAGE_EXPRESSIONS. Fluxer sends a Guild Stickers Update event.

Query parameters

Section titled “Query parameters”
FieldTypeDescription
purge?booleanWhether to permanently delete the stored image (default false)

Response

Section titled “Response”
StatusBodyCondition
204emptyThe sticker was deleted
403error responseMISSING_ACCESS when purge is set and the guild lacks EXPRESSION_PURGE_ALLOWED
404error responseUNKNOWN_STICKER when the sticker isn't in the guild

The rate limit is 10 requests per 30 seconds, on the guild:sticker:delete::guild_id bucket. The daily rate limit is 300 requests per day, on the guild:sticker:delete:daily::guild_id bucket.