openapi: 3.1.0 info: version: 2025.4.1-io.12b-fb6fbea074 title: Misskey account channels API servers: - url: https://misskey.io/api tags: - name: channels paths: /channels/create: post: operationId: post___channels___create summary: channels/create description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:channels*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/channels/create.ts tags: - channels security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 128 description: type: - string - 'null' minLength: 1 maxLength: 2048 bannerId: type: - string - 'null' format: misskey:id color: type: string minLength: 1 maxLength: 16 isSensitive: type: - boolean - 'null' allowRenoteToExternal: type: - boolean - 'null' required: - name responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/Channel' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: cd1e9f3e-5a12-4ab4-96f6-5d0a2cc32050 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 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '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 /channels/favorite: post: operationId: post___channels___favorite summary: channels/favorite description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:channels*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/channels/favorite.ts tags: - channels security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: channelId: type: string format: misskey:id required: - channelId responses: '204': description: OK (without any results) '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: 4938f5f3-6167-4c04-9149-6607b7542861 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 /channels/featured: post: operationId: post___channels___featured summary: channels/featured description: 'No description provided. **Credential required**: *No*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/channels/featured.ts tags: - channels responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Channel' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: 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 /channels/featured-games: post: operationId: post___channels___featured-games summary: channels/featured-games description: 'No description provided. **Credential required**: *No*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/channels/featured-games.ts tags: - channels responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Channel' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: 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 /channels/follow: post: operationId: post___channels___follow summary: channels/follow description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:channels*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/channels/follow.ts tags: - channels security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: channelId: type: string format: misskey:id required: - channelId responses: '204': description: OK (without any results) '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: c0031718-d573-4e85-928e-10039f1fbb68 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 /channels/followed: post: operationId: post___channels___followed summary: channels/followed description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:channels*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/channels/followed.ts tags: - channels security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 5 responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Channel' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: 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 /channels/my-favorites: post: operationId: post___channels___my-favorites summary: channels/my-favorites description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:channels*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/channels/my-favorites.ts tags: - channels security: - bearerAuth: [] responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Channel' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: 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 /channels/owned: post: operationId: post___channels___owned summary: channels/owned description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:channels*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/channels/owned.ts tags: - channels security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 5 responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Channel' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: 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 /channels/search: post: operationId: post___channels___search summary: channels/search description: 'No description provided. **Credential required**: *No*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/channels/search.ts tags: - channels requestBody: required: true content: application/json: schema: type: object properties: query: type: string type: type: string enum: - nameAndDescription - nameOnly default: nameAndDescription sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 5 required: - query responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Channel' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: 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 /channels/show: post: operationId: post___channels___show summary: channels/show description: 'No description provided. **Credential required**: *No*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/channels/show.ts tags: - channels requestBody: required: true content: application/json: schema: type: object properties: channelId: type: string format: misskey:id required: - channelId responses: '200': description: OK (with results) content: application/json: schema: type: object $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: 6f6c314b-7486-4897-8966-c04a66a02923 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 /channels/unfavorite: post: operationId: post___channels___unfavorite summary: channels/unfavorite description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:channels*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/channels/unfavorite.ts tags: - channels security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: channelId: type: string format: misskey:id required: - channelId responses: '204': description: OK (without any results) '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: 353c68dd-131a-476c-aa99-88a345e83668 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 /channels/unfollow: post: operationId: post___channels___unfollow summary: channels/unfollow description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:channels*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/channels/unfollow.ts tags: - channels security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: channelId: type: string format: misskey:id required: - channelId responses: '204': description: OK (without any results) '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: 19959ee9-0153-4c51-bbd9-a98c49dc59d6 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 /channels/update: post: operationId: post___channels___update summary: channels/update description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:channels*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/channels/update.ts tags: - channels security: - bearerAuth: [] 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 - 'null' minLength: 1 maxLength: 2048 bannerId: type: - string - 'null' format: misskey:id isArchived: type: - boolean - 'null' pinnedNoteIds: type: array items: type: string format: misskey:id color: type: string minLength: 1 maxLength: 16 isSensitive: type: - boolean - 'null' allowRenoteToExternal: type: - boolean - 'null' required: - channelId responses: '200': description: OK (with results) content: application/json: schema: type: object $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 components: schemas: Note: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time deletedAt: type: - string - 'null' format: date-time text: type: - string - 'null' cw: type: - string - 'null' userId: type: string format: id user: type: object $ref: '#/components/schemas/UserLite' replyId: type: - string - 'null' format: id example: xxxxxxxxxx renoteId: type: - string - 'null' format: id example: xxxxxxxxxx reply: type: - object - 'null' anyOf: - $ref: '#/components/schemas/Note' - type: 'null' renote: type: - object - 'null' anyOf: - $ref: '#/components/schemas/Note' - type: 'null' isHidden: type: boolean visibility: type: string enum: - public - home - followers - specified mentions: type: array items: type: string format: id visibleUserIds: type: array items: type: string format: id fileIds: type: array items: type: string format: id files: type: array items: type: object $ref: '#/components/schemas/DriveFile' tags: type: array items: type: string poll: type: - object - 'null' properties: expiresAt: type: - string - 'null' format: date-time multiple: type: boolean choices: type: array items: type: object properties: isVoted: type: boolean text: type: string votes: type: number required: - isVoted - text - votes required: - multiple - choices emojis: type: object additionalProperties: anyOf: - type: string channelId: type: - string - 'null' format: id example: xxxxxxxxxx channel: type: - object - 'null' properties: id: type: string name: type: string color: type: string isSensitive: type: boolean allowRenoteToExternal: type: boolean userId: type: - string - 'null' required: - id - name - color - isSensitive - allowRenoteToExternal - userId localOnly: type: boolean dimension: type: - integer - 'null' reactionAcceptance: type: - string - 'null' enum: - likeOnly - likeOnlyForRemote - nonSensitiveOnly - nonSensitiveOnlyForLocalLikeOnlyForRemote - null reactionEmojis: type: object additionalProperties: anyOf: - type: string reactions: type: object additionalProperties: anyOf: - type: number reactionCount: type: number renoteCount: type: number repliesCount: type: number uri: type: string url: type: string reactionAndUserPairCache: type: array items: type: string clippedCount: type: number myReaction: type: - string - 'null' required: - id - createdAt - text - userId - user - visibility - reactionAcceptance - reactionEmojis - reactions - reactionCount - renoteCount - repliesCount DriveFile: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time name: type: string example: 192.jpg type: type: string example: image/jpeg md5: type: string format: md5 example: 15eca7fba0480996e2245f5185bf39f2 size: type: number example: 51469 isSensitive: type: boolean isSensitiveByModerator: type: - boolean - 'null' blurhash: type: - string - 'null' properties: type: object properties: width: type: number example: 1280 height: type: number example: 720 orientation: type: number example: 8 avgColor: type: string example: rgb(40,65,87) url: type: string format: url thumbnailUrl: type: - string - 'null' format: url comment: type: - string - 'null' folderId: type: - string - 'null' format: id example: xxxxxxxxxx folder: type: - object - 'null' anyOf: - $ref: '#/components/schemas/DriveFolder' - type: 'null' userId: type: - string - 'null' format: id example: xxxxxxxxxx user: type: - object - 'null' anyOf: - $ref: '#/components/schemas/UserLite' - type: 'null' required: - id - createdAt - name - type - md5 - size - isSensitive - blurhash - properties - url - thumbnailUrl - comment - folderId - userId Channel: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time lastNotedAt: type: - string - 'null' format: date-time name: type: string description: type: - string - 'null' userId: type: - string - 'null' format: id bannerUrl: type: - string - 'null' format: url pinnedNoteIds: type: array items: type: string format: id color: type: string isArchived: type: boolean usersCount: type: number notesCount: type: number isSensitive: type: boolean allowRenoteToExternal: type: boolean isFollowing: type: boolean isFavorited: type: boolean pinnedNotes: type: array items: type: object $ref: '#/components/schemas/Note' required: - id - createdAt - lastNotedAt - name - description - userId - bannerUrl - pinnedNoteIds - color - isArchived - usersCount - notesCount - isSensitive - allowRenoteToExternal DriveFolder: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time name: type: string parentId: type: - string - 'null' format: id example: xxxxxxxxxx foldersCount: type: number filesCount: type: number parent: type: - object - 'null' anyOf: - $ref: '#/components/schemas/DriveFolder' - type: 'null' required: - id - createdAt - name - parentId UserLite: type: object properties: id: type: string format: id example: xxxxxxxxxx name: type: - string - 'null' example: 藍 username: type: string example: ai host: type: - string - 'null' example: misskey.example.com description: The local host is represented with `null`. avatarUrl: type: - string - 'null' format: url avatarBlurhash: type: - string - 'null' avatarDecorations: type: array items: type: object properties: id: type: string format: id angle: type: number flipH: type: boolean url: type: string format: url offsetX: type: number offsetY: type: number required: - id - url isBot: type: boolean isCat: type: boolean requireSigninToViewContents: type: boolean makeNotesFollowersOnlyBefore: type: - number - 'null' makeNotesHiddenBefore: type: - number - 'null' instance: type: object properties: name: type: - string - 'null' softwareName: type: - string - 'null' softwareVersion: type: - string - 'null' iconUrl: type: - string - 'null' faviconUrl: type: - string - 'null' themeColor: type: - string - 'null' required: - name - softwareName - softwareVersion - iconUrl - faviconUrl - themeColor emojis: type: object additionalProperties: type: string onlineStatus: type: string enum: - unknown - online - active - offline badgeRoles: type: array items: type: object properties: name: type: string iconUrl: type: - string - 'null' displayOrder: type: number behavior: type: string required: - name - iconUrl - displayOrder required: - id - name - username - host - avatarUrl - avatarBlurhash - avatarDecorations - emojis - onlineStatus Error: type: object properties: error: type: object description: An error object. properties: code: type: string description: An error code. Unique within the endpoint. message: type: string description: An error message. id: type: string format: uuid description: An error ID. This ID is static. required: - code - id - message required: - error securitySchemes: bearerAuth: type: http scheme: bearer externalDocs: description: Repository url: https://github.com/MisskeyIO/misskey