Category

The Category object represents a category for notifications. Emails are sent within specific categories. Operations administrators can disable email sending for certain categories. User-level opt-outs are also managed through these categories.

This object contains the following attributes:

Field	Type	Description
id	string, core	(Read-only) The primary identifier for the category.
href	string, core	(Read-only) A relative reference to the object.
name	string, core	The name of the category.
shortDescription	string, core	A short description of the category. The description is displayed in the notification settings view for contacts.
description	string	A detailed description of the category. It describes the overall purpose of this category and can be used to include links to the documentation.
status	enum	The status of the category. Only published categories are visible to clients and vendors.
note	string	Notes to unpublish a category.
optOutAllowed	bool	Indicates if a contact can disable a notification category.
statistics	object	(Read-only) Statistics indicating how many messages of a given category were sent today, this week, and this month. Example: { "messagesSent": { "today": 22, "currentWeek": 244, "currentMonth": 668 } }
audit	object	(Read-only) Represents the audit object.

Example

CATEGORY OBJECT

{
  "id": "NTC-1234-9876",
  "href": "/v1/notifications/categories/NTC-1234-9876",
  "name": "Orders",
  "shortDescription": "Includes updates about order confirmations, order status updates, and related communications.",
  "description": "This category is used by the platform to provide notifications regarding\nOrders updates when a new Order is created, an existing\nOrder is updated or validation failed.",
  "status": "Published",
  "optOutAllowed": "true",
  "statistics": {
    "messagesSent": 
    {
      "today": 22,
      "currentWeek": 244,
      "currentMonth": 668
    }
  },
  "audit": {
    "created": { 
      "at": "2023-12-14T17:28:57Z", 
      "by": {
        "id": "UR-1234-1234-1234",
        "name": "John Smith",
        "icon": "/static/users/UR-1234-1234-1234.icon.svg"
      },
      "of": {
        "id": "ACC-1234-1234",
        "href": "/accounts/accounts/ACC-1234-1234",
        "name": "Microsoft",
        "icon": "/static/ACC-1234-1234/account.png"
      }
    }
  }
}