エンドポイント一覧

users/lists/create-from-public

POSTAPIの概要 実装を見る

No description provided.

Credential required: Yes

パラメータ

名前型既定値
必須name文字列-
必須listId文字列-

200 レスポンス リクエスト成功（内容あり）

名前型例
UserList

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

名前型例
なし

401 エラー 認証エラー

名前型例
なし

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

名前型例
なし

418 エラー I'm Ai

名前型例
なし

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

名前型例
なし
{
  "_path": "/api-docs/endpoints/users/lists/create-from-public",
  "_dir": "lists",
  "_draft": false,
  "_partial": false,
  "_locale": "",
  "data": {
    "post": {
      "operationId": "users/lists/create-from-public",
      "summary": "users/lists/create-from-public",
      "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/users/lists/create-from-public.ts"
      },
      "security": [
        {
          "ApiKeyAuth": []
        }
      ],
      "requestBody": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                },
                "listId": {
                  "type": "string",
                  "format": "misskey:id"
                }
              },
              "required": [
                "name",
                "listId"
              ]
            }
          }
        }
      },
      "responses": {
        "200": {
          "description": "OK (with results)",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "optional": false,
                "nullable": false,
                "ref": "UserList",
                "$ref": "#/components/schemas/UserList"
              }
            }
          }
        },
        "400": {
          "description": "Client error",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Error"
              },
              "examples": {
                "TOO_MANY_USERLISTS": {
                  "value": {
                    "error": {
                      "message": "You cannot create user list any more.",
                      "code": "TOO_MANY_USERLISTS",
                      "id": "e9c105b2-c595-47de-97fb-7f7c2c33e92f"
                    }
                  }
                },
                "NO_SUCH_LIST": {
                  "value": {
                    "error": {
                      "message": "No such list.",
                      "code": "NO_SUCH_LIST",
                      "id": "9292f798-6175-4f7d-93f4-b6742279667d"
                    }
                  }
                },
                "NO_SUCH_USER": {
                  "value": {
                    "error": {
                      "message": "No such user.",
                      "code": "NO_SUCH_USER",
                      "id": "13c457db-a8cb-4d88-b70a-211ceeeabb5f"
                    }
                  }
                },
                "ALREADY_ADDED": {
                  "value": {
                    "error": {
                      "message": "That user has already been added to that list.",
                      "code": "ALREADY_ADDED",
                      "id": "c3ad6fdb-692b-47ee-a455-7bd12c7af615"
                    }
                  }
                },
                "YOU_HAVE_BEEN_BLOCKED": {
                  "value": {
                    "error": {
                      "message": "You cannot push this user because you have been blocked by this user.",
                      "code": "YOU_HAVE_BEEN_BLOCKED",
                      "id": "a2497f2a-2389-439c-8626-5298540530f4"
                    }
                  }
                },
                "TOO_MANY_USERS": {
                  "value": {
                    "error": {
                      "message": "You can not push users any more.",
                      "code": "TOO_MANY_USERS",
                      "id": "1845ea77-38d1-426e-8e4e-8b83b24f5bd7"
                    }
                  }
                },
                "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": "users/lists/create-from-public",
  "_id": "content:api-docs:endpoints:users:lists:create-from-public.json",
  "_type": "json",
  "_source": "content",
  "_file": "api-docs/endpoints/users/lists/create-from-public.json",
  "_extension": "json"
}