social.colibri.beta.emoji.rename

colibri.social

Documentation

Renames a community's custom emoji. Providers that key records by name move the record to a new key and repoint pack memberships, so the emoji's URI changes.

main procedure

Renames a community's custom emoji. Providers that key records by name move the record to a new key and repoint pack memberships, so the emoji's URI changes.

Input

Encodingapplication/json
community stringdid Required

The community that owns the emoji.

emoji stringat-uri Required

The emoji's record URI in the community's repo.

name string Required

The emoji's name without colons. Lowercase letters, digits and underscores.

maxLength: 32 bytesminLength: 2 bytes

Output

Encodingapplication/json

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.
Forbidden The caller lacks the community.manage permission.
CommunityNotFound No community exists at the given DID.
EmojiNotFound No emoji of this community exists at the given URI.
InvalidName The name is not 2 to 32 characters of lowercase letters, digits and underscores.
NameTaken The community already has an emoji with this name.
UnsupportedProvider The emoji provider is unknown, or it does not support the requested operation.
CredentialsUnavailable The AppView cannot act as the community because its stored credentials are missing or unusable.
UpstreamFailure A PDS call the AppView depends on failed.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Renames a community's custom emoji. Providers that key records by name move the record to a new key and repoint pack memberships, so the emoji's URI changes.",
  "errors": [
    {
      "description": "The request is missing, malformed, or unverifiable service auth.",
      "name": "AuthRequired"
    },
    {
      "description": "The caller lacks the community.manage permission.",
      "name": "Forbidden"
    },
    {
      "description": "No community exists at the given DID.",
      "name": "CommunityNotFound"
    },
    {
      "description": "No emoji of this community exists at the given URI.",
      "name": "EmojiNotFound"
    },
    {
      "description": "The name is not 2 to 32 characters of lowercase letters, digits and underscores.",
      "name": "InvalidName"
    },
    {
      "description": "The community already has an emoji with this name.",
      "name": "NameTaken"
    },
    {
      "description": "The emoji provider is unknown, or it does not support the requested operation.",
      "name": "UnsupportedProvider"
    },
    {
      "description": "The AppView cannot act as the community because its stored credentials are missing or unusable.",
      "name": "CredentialsUnavailable"
    },
    {
      "description": "A PDS call the AppView depends on failed.",
      "name": "UpstreamFailure"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "community": {
          "description": "The community that owns the emoji.",
          "format": "did",
          "type": "string"
        },
        "emoji": {
          "description": "The emoji's record URI in the community's repo.",
          "format": "at-uri",
          "type": "string"
        },
        "name": {
          "description": "The emoji's name without colons. Lowercase letters, digits and underscores.",
          "maxLength": 32,
          "minLength": 2,
          "type": "string"
        }
      },
      "required": [
        "community",
        "emoji",
        "name"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "emoji": {
          "description": "The emoji as stored.",
          "ref": "social.colibri.beta.emoji.defs#emojiView",
          "type": "ref"
        }
      },
      "required": [
        "emoji"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@