Disable push notification settings

Prev Next

Available in Classic and VPC

Disable push notifications set for a user.

Request

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

Method URI
DELETE /v1/api/members/{userId}/notification

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
userId String Required User ID

Request example

The request example is as follows:

curl --location --request DELETE 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/39c8de0f-****-****-****-6a1a875df59f/notification' \
--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
member Object - User information
member.id String - User ID
member.notifications Object - Push notification settings history
  • Since the settings are disabled, null is displayed for child information.
member.notifications.token String - Push token
member.notifications.device String - Device push type
  • FCM | APNS
member.notifications.os String - Operating system version
member.notifications.push Boolean - Whether to allow push notifications
  • true | false
    • true: Allow
    • false: Block
member.notifications.ad Boolean - Whether to allow ad push notifications
  • true | false
    • true: Allow
    • false: Block
member.notifications.night Boolean - Whether to allow night push notifications
  • true | false
    • true: Allow
    • false: Block
member.notifications.timezone String - Time zone
  • null is displayed if not set.
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:

{
    "member": {
        "id": "39c8de0f-****-****-****-6a1a875df59f",
        "notifications": {
            "token": null,
            "device": null,
            "os": null,
            "push": null,
            "ad": null,
            "night": null,
            "timezone": null
        }
    },
    "status": 1
}