Page tree

Overview

This API call applies to both Armor Complete and Armor Anywhere users.

The Get User Notification Settings API retrieves a user's notification setting. Notification settings determine the types of notifications a user is subscribed to, such as Technical Notifications or Ticket Notifications.

Additionally, this API determines how to send these notifications. There are three ways to receive a notification: 

  • An alert in the Armor Management Portal (AMP)
  • A text message
  • An email

Sample request

GET https://api.armor.com/users/notifications

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/users/notificationsGET


There are no parameters for this API call. 


Sample return

StatusResponse
200
{
 "notificationPreferences": [
   {
     "userId": 2,
     "accountId": 2,
     "notificationTypeId": "7",
     "notificationType": "Billing",
     "alert": true,
     "sms": false,
     "email": false
   },
   {
     "userId": 2,
     "accountId": 2,
     "notificationTypeId": "3",
     "notificationType": "Ticket",
     "alert": true,
     "sms": false,
     "email": true
   },
   {
     "userId": 2,
     "accountId": 2,
     "notificationTypeId": "2",
     "notificationType": "Security",
     "alert": false,
     "sms": false,
     "email": false
   },
   {
     "userId": 2,
     "accountId": 2,
     "notificationTypeId": "1",
     "notificationType": "Account",
     "alert": false,
     "sms": false,
     "email": true
   },
   {
     "userId": 2,
     "accountId": 2,
     "notificationTypeId": "8",
     "notificationType": "Technical",
     "alert": false,
     "sms": false,
     "email": true
   }
 ]
}






In this topic



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.