Skip to main content
GET
/
api
/
v3
/
notification
/
setting
Get push notification setting.
curl --request GET \
  --url https://apix.us.amity.co/api/v3/notification/setting \
  --header 'Authorization: Bearer <token>'
{
  "isPushNotifiable": true,
  "isUserEnabled": true,
  "notifiableEvents": [
    {
      "eventName": "<string>",
      "isPushNotifiable": true,
      "parameters": [
        "<string>"
      ],
      "titleTemplate": "<string>",
      "bodyTemplate": "<string>",
      "listenFromRoleIds": [
        "<string>"
      ],
      "ignoreFromRoleIds": [
        "<string>"
      ],
      "isNetworkEnabled": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
level
enum<string>
required
Available options:
user,
channel,
community
​
channelId
string
Required string length: 1 - 900
​
communityId
string
Required string length: 1 - 900

Response

Notification Setting Information

​
isPushNotifiable
boolean

on/off notification

​
isUserEnabled
boolean

enable/disable notification from user level(for community level)

​
notifiableEvents
object[]