Category

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

This object contains the following attributes:

Field
Type
Description

id

string

The primary identifier for the category.

Example: NTC-1234-9876

href

string

A relative reference to the object.

Example: /v1/notifications/categories/NTC-1234-9876

name

string

The name of the category.

Example: Orders

shortDescription

string

The short description, shown in the notification settings view for contacts.

Example: Includes updates about order confirmations, order status updates, and related communications.

description

string

Detailed description of the category to be shown on the platform. The description describes the overall purpose of this category. It can be used to include the links to our documentation for more information.

status

enum

The status of the category. Only published categories are visible to clients and vendors.

note

string

Notes that must be added to unpublish a category.

optOutAllowed

bool

Indicates if a contact can disable a notification category.

Example: true

statistics

object

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

A reference to the Audit object.

Example:

"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"
  }
}

Example

{
  "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"
      }
    }
  }
}

Last updated

Was this helpful?