Rename a custom emoji | Sample

3 body fields

Form data identifying the emoji and its replacement name. token, name, and new_name are required.

tokenstringrequired

Authentication token. Requires scope: `admin.teams:write`

namestringrequired

The name of the emoji to be renamed. Colons (`:myemoji:`) around the value are not required, although they may be included.

new_namestringrequired

The new name of the emoji.

2 status codes

200Returns an object containing `ok: true` when the custom emoji is renamed.

okbooleanrequired

Allowed:true

defaultReturns an object containing `ok: false` when the custom emoji cannot be renamed.

okbooleanrequired

Allowed:false

Error handling

token, name, and new_name are required. The token must have the admin.teams:write scope, and name may include surrounding colons.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.adminEmojiRename.create({
  token: "sk_live_4eC39Hq",
  name: "Untitled",
  newName: "Untitled",
});

{
  "ok": true
}

Request

Response

Errors