AlphaAlpha Docs

Notification Settings

User Notification Settings API

Get current user's notification settings

GET
/notifications/settings/me
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/notifications/settings/me"
{
  "digestFrequency": "OFF",
  "disabledScopes": [
    "string"
  ],
  "enabledCategories": [
    "ERP"
  ],
  "id": "string",
  "inAppNotificationsEnabled": true,
  "pushNotificationsEnabled": true,
  "userId": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Update current user's notification settings

PUT
/notifications/settings/me
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:18080/api/v1/notifications/settings/me" \  -H "Content-Type: application/json" \  -d '{    "digestFrequency": "OFF",    "disabledScopes": [      "string"    ],    "enabledCategories": [      "ERP"    ],    "inAppNotificationsEnabled": true,    "pushNotificationsEnabled": true  }'
{
  "digestFrequency": "OFF",
  "disabledScopes": [
    "string"
  ],
  "enabledCategories": [
    "ERP"
  ],
  "id": "string",
  "inAppNotificationsEnabled": true,
  "pushNotificationsEnabled": true,
  "userId": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get available notification scopes

GET
/notifications/settings/scopes
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/notifications/settings/scopes"
[
  {
    "category": "ERP",
    "label": "string",
    "scope": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}