admin/emoji/update

POSTAPIの概要 実装を見る

No description provided.

Credential required: Yes

パラメータ

名前既定値
必須id文字列-
必須name文字列-
fileId文字列-
任意category文字列-
必須aliases配列(内容: 文字列)-
任意license文字列-
isSensitive真偽値-
localOnly真偽値-
roleIdsThatCanBeUsedThisEmojiAsReaction配列(内容: 文字列)-

204 レスポンス リクエスト成功(内容なし)

なし

400 エラー クライアント側エラー

名前
なし

401 エラー 認証エラー

名前
なし

403 エラー 権限関連のエラー

名前
なし

418 エラー I'm Ai

名前
なし

500 エラー サーバー内部エラー

名前
なし
{
  "_path": "/api-docs/endpoints/admin/emoji/update",
  "_dir": "emoji",
  "_draft": false,
  "_partial": false,
  "_locale": "",
  "data": {
    "post": {
      "operationId": "admin/emoji/update",
      "summary": "admin/emoji/update",
      "description": "No description provided.\n\n**Credential required**: *Yes*",
      "externalDocs": {
        "description": "Source code",
        "url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/update.ts"
      },
      "tags": [
        "admin"
      ],
      "security": [
        {
          "ApiKeyAuth": []
        }
      ],
      "requestBody": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "format": "misskey:id"
                },
                "name": {
                  "type": "string",
                  "pattern": "^[a-zA-Z0-9_]+$"
                },
                "fileId": {
                  "type": "string",
                  "format": "misskey:id"
                },
                "category": {
                  "type": "string",
                  "nullable": true,
                  "description": "Use `null` to reset the category."
                },
                "aliases": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "license": {
                  "type": "string",
                  "nullable": true
                },
                "isSensitive": {
                  "type": "boolean"
                },
                "localOnly": {
                  "type": "boolean"
                },
                "roleIdsThatCanBeUsedThisEmojiAsReaction": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "id",
                "name",
                "aliases"
              ]
            }
          }
        }
      },
      "responses": {
        "204": {
          "description": "OK (without any results)"
        },
        "400": {
          "description": "Client error",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Error"
              },
              "examples": {
                "NO_SUCH_EMOJI": {
                  "value": {
                    "error": {
                      "message": "No such emoji.",
                      "code": "NO_SUCH_EMOJI",
                      "id": "684dec9d-a8c2-4364-9aa8-456c49cb1dc8"
                    }
                  }
                },
                "NO_SUCH_FILE": {
                  "value": {
                    "error": {
                      "message": "No such file.",
                      "code": "NO_SUCH_FILE",
                      "id": "14fb9fd9-0731-4e2f-aeb9-f09e4740333d"
                    }
                  }
                },
                "SAME_NAME_EMOJI_EXISTS": {
                  "value": {
                    "error": {
                      "message": "Emoji that have same name already exists.",
                      "code": "SAME_NAME_EMOJI_EXISTS",
                      "id": "7180fe9d-1ee3-bff9-647d-fe9896d2ffb8"
                    }
                  }
                },
                "INVALID_PARAM": {
                  "value": {
                    "error": {
                      "message": "Invalid param.",
                      "code": "INVALID_PARAM",
                      "id": "3d81ceae-475f-4600-b2a8-2bc116157532"
                    }
                  }
                }
              }
            }
          }
        },
        "401": {
          "description": "Authentication error",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Error"
              },
              "examples": {
                "CREDENTIAL_REQUIRED": {
                  "value": {
                    "error": {
                      "message": "Credential required.",
                      "code": "CREDENTIAL_REQUIRED",
                      "id": "1384574d-a912-4b81-8601-c7b1c4085df1"
                    }
                  }
                }
              }
            }
          }
        },
        "403": {
          "description": "Forbidden error",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Error"
              },
              "examples": {
                "AUTHENTICATION_FAILED": {
                  "value": {
                    "error": {
                      "message": "Authentication failed. Please ensure your token is correct.",
                      "code": "AUTHENTICATION_FAILED",
                      "id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14"
                    }
                  }
                }
              }
            }
          }
        },
        "418": {
          "description": "I'm Ai",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Error"
              },
              "examples": {
                "I_AM_AI": {
                  "value": {
                    "error": {
                      "message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.",
                      "code": "I_AM_AI",
                      "id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84"
                    }
                  }
                }
              }
            }
          }
        },
        "500": {
          "description": "Internal server error",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Error"
              },
              "examples": {
                "INTERNAL_ERROR": {
                  "value": {
                    "error": {
                      "message": "Internal error occurred. Please contact us if the error persists.",
                      "code": "INTERNAL_ERROR",
                      "id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "title": "admin/emoji/update",
  "_id": "content:api-docs:endpoints:admin:emoji:update.json",
  "_type": "json",
  "_source": "content",
  "_file": "api-docs/endpoints/admin/emoji/update.json",
  "_extension": "json"
}