sticker_update

Edit an existing custom sticker. The sticker keeps its ID.

Request

{
  "cmd": "sticker_update",
  "sticker_id": "2",
  "description": "A sleepy cat waking up"
}

Field	Type	Required	Description
sticker_id	string or integer	Yes	The sticker’s ID. Must be digits only.
name	string	No	New name. Same rules as sticker_add: 2 to 64 letters, digits, or underscores.
image	string	No	New image as a base64 data URI. Same rules as sticker_add.
description	string	No	New description. Send "" to clear it.

Send at least one of name, image, or description. Fields you leave out stay the same.

Response

{
  "cmd": "sticker_update",
  "id": "2",
  "name": "good_morning",
  "fileName": "2.png",
  "description": "A sleepy cat waking up",
  "updated": true
}

If nothing changed, the response is { "cmd": "sticker_update", "id": "2", "updated": false }. That happens when:

• no sticker has that ID, or
• another sticker already uses the new name, ignoring case.

A new image with a different type changes fileName, for example from 2.png to 2.webp. The old file is deleted.

Caution

The server sends sticker images with Cache-Control: public, max-age=86400, immutable. If the new image has the same type as the old one, fileName stays the same and browsers may show the old image for up to a day.

The server doesn’t broadcast the change.

Permissions

Requires manage_emojis. A user in timeout gets a rate_limit frame instead.

Errors

val	When
Invalid sticker_update data: sticker_id must be an integer	sticker_id is missing or isn’t a non-negative whole number. This is checked first.
value: Expected a value for at least one of [name image description]	None of name, image, or description was sent.
description: Expected string, received number	name, image, or description isn’t a string.
Invalid sticker_update data: Invalid name	The new name breaks the naming rules.
Invalid sticker_update data: Image must be a base64 data URI	image isn’t in the form data:image/<type>;base64,<data>.
Invalid sticker_update data: Unsupported image type	The image type isn’t in uploads.sticker_allowed_file_types.
Invalid sticker_update data: Invalid image data	The data is empty, isn’t valid base64, or doesn’t match the declared type.
Invalid sticker_update data: Custom asset storage is unavailable	The sticker index file can’t be read.
Invalid sticker_update data: Failed to save custom asset	The change couldn’t be written.

See also

• sticker_add
• sticker_get