POSTAPIの概要 実装を見る
No description provided.
Credential required: Yes / Permission: write:channels
パラメータ
| 名前 | 型 | 既定値 |
|---|
| 必須 | channelId | 文字列 | - |
| name | 文字列 | - |
| 任意 | description | 文字列 | - |
| 任意 | bannerId | 文字列 | - |
| 任意 | isArchived | 真偽値 | - |
| pinnedNoteIds | 配列（内容: 文字列） | - |
| color | 文字列 | - |
| 任意 | isSensitive | 真偽値 | - |
200 レスポンス リクエスト成功（内容あり）
400 エラー クライアント側エラー
401 エラー 認証エラー
403 エラー 権限関連のエラー
418 エラー I'm Ai
500 エラー サーバー内部エラー
{
"_path": "/api-docs/endpoints/channels/update",
"_dir": "channels",
"_draft": false,
"_partial": false,
"_locale": "",
"data": {
"post": {
"operationId": "channels/update",
"summary": "channels/update",
"description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:channels*",
"externalDocs": {
"description": "Source code",
"url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/channels/update.ts"
},
"tags": [
"channels"
],
"security": [
{
"ApiKeyAuth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"channelId": {
"type": "string",
"format": "misskey:id"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 2048
},
"bannerId": {
"type": "string",
"format": "misskey:id",
"nullable": true
},
"isArchived": {
"type": "boolean",
"nullable": true
},
"pinnedNoteIds": {
"type": "array",
"items": {
"type": "string",
"format": "misskey:id"
}
},
"color": {
"type": "string",
"minLength": 1,
"maxLength": 16
},
"isSensitive": {
"type": "boolean",
"nullable": true
}
},
"required": [
"channelId"
]
}
}
}
},
"responses": {
"200": {
"description": "OK (with results)",
"content": {
"application/json": {
"schema": {
"type": "object",
"optional": false,
"nullable": false,
"ref": "Channel",
"$ref": "#/components/schemas/Channel"
}
}
}
},
"400": {
"description": "Client error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"NO_SUCH_CHANNEL": {
"value": {
"error": {
"message": "No such channel.",
"code": "NO_SUCH_CHANNEL",
"id": "f9c5467f-d492-4c3c-9a8d-a70dacc86512"
}
}
},
"ACCESS_DENIED": {
"value": {
"error": {
"message": "You do not have edit privilege of the channel.",
"code": "ACCESS_DENIED",
"id": "1fb7cb09-d46a-4fdf-b8df-057788cce513"
}
}
},
"NO_SUCH_FILE": {
"value": {
"error": {
"message": "No such file.",
"code": "NO_SUCH_FILE",
"id": "e86c14a4-0da2-4032-8df3-e737a04c7f3b"
}
}
},
"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": "channels/update",
"_id": "content:api-docs:endpoints:channels:update.json",
"_type": "json",
"_source": "content",
"_file": "api-docs/endpoints/channels/update.json",
"_extension": "json"
}