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:
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:
audit
A reference to the Audit object.
Example:
Example
Last updated
Was this helpful?