Message Center Alerts
An alert can be triggered as an email to advisors and/or advisees under various scenarios. These alerts are also avaialble to view on the advisor and advisee portals and via the GSAS APis. This guide provides information on how to access the message center alerts for the authenticated user.
Alert Categories
| categoryId | Description |
|---|---|
| 3RD | 3rd Party Messages |
| ACC | Account Information |
| CON | Confidential Messages |
| DEP | Deposits Withdrawals and Transfers |
| FMS | Funds Movement Summary |
| MOD | Model & Allocation Alerts |
| PRO | Product Messages |
| PXY | Proxy, Tender Offers and Other Corp. Actions |
| SEC | Security |
| TAX | Tax Information |
| TRD | Trading |
Alert Statuses
| Status | Meaning |
|---|---|
| U | Unread |
| R | Read |
| D | Delete |
Endpoints
| API Name | API Endpoint | Purpose |
|---|---|---|
| List messages | GET /api/v2/messages | This will list out all the user’s messages. |
| Get message | GET /api/v2/messages/{messageId} | This will return a specific message based on the messageId you provide. |
| Update message status | PUT /api/v2/messages | This allows you to change the Read status of a message. |
| Update a user’s message center global notification settings | PUT /api/v2/messages/notification-settings/global | This allows you to change a user’s global notification or “mark if read” setting, which will automatically mark any message as “Read” if the message is forwarded to the user’s email. |
| Update a user's message center category notification settings | PUT /api/v2/messages/notification-settings/category | This allows you to change a user’s category notification or “forward via email” setting, which allows users to set certain categories of messages to be forwarded to their email. Note that the category Security cannot be changed for this setting. |
| Get unread messages count | GET /api/v2/unread-messages-count | This will return the number of unread messages that the user has |
| List a user's message center notification settings | GET /api/v2/messages/notification-settings | This will return the user’s message center global notification or “mark if read” setting. |
Was this page useful?
Give feedback to help us improve developer.gs.com and serve you better.