Create channel

Available in Classic and VPC

Create a channel.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
POST	/v1/api/channels

Request headers

For information about the headers common to all Ncloud Chat APIs, see Ncloud Chat request headers.

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`name`	String	Required	Channel name
`uniqueId`	String	Optional	Channel unique ID ID that the user enters for unique identification purposes
`type`	String	Required	Channel type `PUBLIC` \| `PRIVATE` `PUBLIC`: Public `PRIVATE`: Private
`translation`	Boolean	Optional	Automatic translation `true` \| `false` (default) `true`: Translate `false`: Not translate
`members`	Array	Optional	List of subscribable user IDs Enter if `type` is `PRIVATE`.
`disabled`	Boolean	Optional	Whether it is disabled `true` \| `false` (default) `true`: Disabled `false`: Enabled
`mutes`	Boolean	Optional	Whether to mute `true` \| `false` (default) `true`: Mute `false`: Not mute
`push`	Boolean	Optional	Whether to allow push notifications `true` (default) \| `false` `true`: Allow `false`: Block
`limit`	Integer	Optional	Maximum number of participants `0`: Unlimited
`linkUrl`	String	Optional	Channel link URL Enter a URL that satisfies certain conditions.
`imageUrl`	String	Optional	Channel image URL Enter a URL that satisfies certain conditions.

Note

The channel link URL (linkUrl) and channel image URL (imageUrl) must meet the following conditions.

You can't enter just the domain.
The target server must return a status code of 200 (OK).
The response must contain a header and content-type.
Example channel image 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

Request example

The request example is as follows:

curl --location --request POST 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "channelname135",
    "uniqueId": "channel135",
    "type": "PRIVATE",
    "translation": true,
    "members": [
        "user_5", "NCP007", "NCP001TestAOS", "osoriz123"
    ],
    "disabled": false,
    "mutes": false,
    "push": true,
    "limit": 20,
    "linkUrl": "{Link URL}",
    "imageUrl": "{Image URL}"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`channel`	Object	-	Channel information
`channel.id`	String	-	Channel ID
`channel.project_id`	String	-	Project ID
`channel.name`	String	-	Channel name
`channel.user_id`	String	-	Channel creator ID
`channel.user`	Object	-	Creator information
`channel.user.id`	String	-	Channel creator ID
`channel.user.name`	String	-	Creator name
`channel.user.profile`	String	-	Creator profile image
`channel.unique_id`	String	-	Channel unique ID ID that the user enters for unique identification purposes
`channel.type`	String	-	Channel type `PUBLIC` \| `PRIVATE` `PUBLIC`: Public `PRIVATE`: Private
`channel.translation`	Boolean	-	Automatic translation `true` \| `false` `true`: Translate `false`: Not translate
`channel.members`	Array	-	List of subscribable user IDs Display valid value if `type` is `PRIVATE`.
`channel.disabled`	Boolean	-	Whether it is disabled `true` \| `false` `true`: Disabled `false`: Enabled
`channel.mutes`	Boolean	-	Whether to mute `true` \| `false` `true`: Mute `false`: Not mute
`channel.push`	Boolean	-	Whether to allow push notifications `true` \| `false` `true`: Allow `false`: Block
`channel.limit`	Integer	-	Maximum number of participants `0`: Unlimited
`channel.link_url`	String	-	Channel link URL
`channel.image_url`	Array	-	Channel image URL
`channel.created_at`	String	-	Channel creation date and time ISO 8601 format
`channel.updated_at`	String	-	Information modification date and time ISO 8601 format
`status`	Integer	-	Response status `1`: Success If not `1`: Failure

Response status codes

For information about the HTTP status codes common to all Ncloud Chat APIs, see Common Ncloud Chat response status codes.

Response example

The response example is as follows:

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