Delete channel

Prev Next

Available in Classic and VPC

The channel is deleted.

Request

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

Method URI
DELETE /v1/api/channels/{channelId}

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
channelId String Required Channel ID

Request example

The request example is as follows:

curl --location --request DELETE 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels/dad2bea7-****-****-****-307a791a7102' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

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": "dad2bea7-****-****-****-307a791a7102",
        "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
        "name": "channelnamee",
        "user_id": "d71157d7-****-****-****-3c4cd4fef46e",
        "user": {
            "id": "TWVtYmVycz************************************RjZDRmZWY0NmU=",
            "name": "Admin",
            "profile": ""
        },
        "unique_id": "unique Id",
        "type": "PRIVATE",
        "translation": true,
        "members": [],
        "disabled": false,
        "mutes": false,
        "push": true,
        "limit": 20,
        "link_url": "{Link URL}",
        "image_url": "{Image URL}",
        "created_at": "2025-07-23T15:40:37+09:00",
        "updated_at": "2025-07-23T16:55:17+09:00"
    },
    "status": 1
}