SEsendbird
User

View push preferences for a channel

Changed on

View push preferences for a channel

You can retrieve a user's notifications preferences for a specific channel. A push notification is a message that is immediately delivered to a user's device when the device is either idle or running the client app in the background. These notifications preferences can be configured.

Note: Push notifications are only available for group channels.

https://sendbird.com/docs/chat/platform-api/v3/user/configuring-notification-preferences/get-push-notification-preferences-for-a-channel#1-get-push-notification-preferences-for-a-channel

get/v3/users/{user_id}/push_preference/{channel_url}

Request

  • Base URL
    https://api-APP_ID.sendbird.com
  • Auth
    none declared

Path parameters

user_idstring required

(Required)

channel_urlstring required

(Required)

Headers

api-tokenstring
Example:{{API_TOKEN}}

Response

Successful response

enableboolean
push_soundstring
push_trigger_option'all' | 'mention_only' | 'off'

Example response

{
  "enable": true,
  "push_sound": "push_sound",
  "push_trigger_option": null
}

Changes

  • 073cffd0bd87Revision changes
    • info

      removed the default enum value from the response property for the response status

  • 7a85bad03e90Revision changes
    • warning

      deleted the header request parameter Api-Token

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new all enum value to the response property for the response status

    • warning

      added the new default enum value to the response property for the response status

    • warning

      added the new mention_only enum value to the response property for the response status

    • warning

      added the new off enum value to the response property for the response status

    • info

      api operation id viewPushPreferencesForChannelByUrl removed and replaced with viewPushPreferencesForAChannel

    • info

      added the new optional header request parameter api-token