チャンネルの更新

Classic/VPC環境で利用できます。

チャンネル情報を更新します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
PUT	/v1/api/channels/{channelId}

リクエストヘッダ

Ncloud Chat APIで共通して使用されるヘッダの詳細は、Ncloud Chatのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`channelId`	String	Required	チャンネル ID チャンネルリストの照会を参照

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	Optional	チャンネル名
`uniqueId`	String	Optional	チャンネル固有 ID 固有の識別目的でユーザーが入力する ID
`type`	String	Optional	チャンネルタイプ `PUBLIC` \| `PRIVATE` `PUBLIC`: 公開 `PRIVATE`: 非公開
`translation`	Boolean	Optional	自動翻訳するか `true` \| `false` `true`: 翻訳 `false`: 翻訳しない
`members`	Array	Optional	購読可能なユーザー IDリスト `type`が`PRIVATE`の場合、入力
`disabled`	Boolean	Optional	無効化かどうか `true` \| `false` `true`: 無効化 `false`: 有効化
`mutes`	Boolean	Optional	ミュートするか `true` \| `false` `true`: ミュート `false`: ミュートしない
`push`	Boolean	Optional	プッシュ通知を許可するか `true` \| `false` `true`: 許可 `false`: ブロック
`limit`	Integer	Optional	最大参加人数 `0`: 無制限
`linkUrl`	String	Optional	チャンネルリンク URL 一定の条件を満たす URLを入力
`imageUrl`	String	Optional	チャンネル画像 URL 一定の条件を満たす URLを入力

参考

チャンネルリンク URL(linkUrl)とチャンネル画像 URL(imageUrl)は、次の条件を満たす必要があります。

ドメインのみ入力することはできません。
対象サーバがステータスコード200(OK)を返す必要があります。
レスポンスに Headerと Content-Typeが含まれている必要があります。
チャンネル画像 URLの例: https://www.gitbook.com/cdn-cgi/image/width=40,dpr=2,height=40,fit=contain,format=auto/https://2238982255-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/spaces%2F-LNAM8Kjj1jpQoidHTej%2Favatar-1592576907682.png?generation=1592576908144636&alt=media

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request PUT 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels/469645e9-****-****-****-d0a58e38d312' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "mychanneltest",
    "uniqueId": "ncpchanneltest789",
    "translation": false,
    "mutes": false,
    "push": true,
    "limit": 40
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`channel`	Object	-	チャンネル情報
`channel.id`	String	-	チャンネル ID
`channel.project_id`	String	-	プロジェクト ID
`channel.name`	String	-	チャンネル名
`channel.user_id`	String	-	チャンネル作成者 ID
`channel.user`	Object	-	作成者情報
`channel.user.id`	String	-	チャンネル作成者 ID
`channel.user.name`	String	-	作成者名
`channel.user.profile`	String	-	作成者のプロファイル画像
`channel.unique_id`	String	-	チャンネル固有 ID 固有の識別目的でユーザーが入力する ID
`channel.type`	String	-	チャンネルタイプ `PUBLIC` \| `PRIVATE` `PUBLIC`: 公開 `PRIVATE`: 非公開
`channel.translation`	Boolean	-	自動翻訳するか `true` \| `false` `true`: 翻訳 `false`: 翻訳しない
`channel.members`	Array	-	購読可能なユーザー IDリスト `type`が`PRIVATE`の場合、有効値を表示
`channel.disabled`	Boolean	-	無効化かどうか `true` \| `false` `true`: 無効化 `false`: 有効化
`channel.mutes`	Boolean	-	ミュートするか `true` \| `false` `true`: ミュート `false`: ミュートしない
`channel.push`	Boolean	-	プッシュ通知を許可するか `true` \| `false` `true`: 許可 `false`: ブロック
`channel.limit`	Integer	-	最大参加人数 `0`: 無制限
`channel.link_url`	String	-	チャンネルリンク URL
`channel.image_url`	Array	-	チャンネル画像 URL
`channel.created_at`	String	-	チャンネルの作成日時 ISO 8601形式
`channel.updated_at`	String	-	情報更新日時 ISO 8601形式
`status`	Integer	-	レスポンスの状態 `1`: 成功 `1`でない場合: 失敗

レスポンスステータスコード

Ncloud Chat APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Chatのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "channel": {
        "id": "469645e9-****-****-****-d0a58e38d312",
        "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
        "name": "mychanneltest",
        "user_id": "d71157d7-****-****-****-3c4cd4fef46e",
        "user": {
            "id": "TWVtYmVyc**************************************jZDRmZWY0NmU=",
            "name": "Admin",
            "profile": ""
        },
        "unique_id": "ncpchanneltest789",
        "type": "PRIVATE",
        "translation": false,
        "members": [
            "user_5",
            "NCP007",
            "NCP001TestAOS",
            "osoriz123"
        ],
        "disabled": false,
        "mutes": false,
        "push": true,
        "limit": 40,
        "link_url": "{Link URL}",
        "image_url": "{Image URL}",
        "created_at": "2025-07-23T16:02:00+09:00",
        "updated_at": "2025-07-23T16:52:10+09:00"
    },
    "status": 1
}