Subscribers

The Subscriber object manages the configuration of notifications for accounts.

It serves as the link between an account and a notification category, storing details about whether that category is enabled for the account and identifying the recipients who should receive notifications for it. This object contains the following properties:

Field	Type	Description
id	string	The primary identifier for the notification subscriber. Example: NTS-1111-2222-1234
href	string	Relative reference to the object. Example: /notifications/subscribers/NTS-1111-2222-1234
name	string	The name of the category. Example: Orders
status	enum	Indicates if the category connected to the configuration is enabled or disabled for the account. Possible enum values: Enabled or Disabled. When disabled, no notifications are sent for the category.
note	string	Notes related to the category. Example: Disabled because we are not interested in this category.
recipients	recipients	The recipient of the notification email. To receive a notification, the user must be in the recipients.users or part of a group that is in recipients.userGroups. Example: { "recipients": { "users": [], "userGroups": [] } }
account	account	A reference to the account object.
category	category	The name of the category. Example: Orders.
audit	auditObject	The audit object with these possible entries: Created or Updated. Example: { "created": { "at": "...", "by": { } }, "updated": { "at": "...", "by": { } } }

Example

SUBSCRIBER OBJECT

{
	"id": "NTS-1111-2222-1234",
	"href": "/notifications/subscribers/NTS-1111-2222-1234",
	"status": "Enabled",
	"category": {
		"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."
	},
	"account": {
		"id": "AC-1111-2222",
		"href": "/accounts/accounts/AC-1111-2222",
		"type": "Client",
		"status": "Active",
		"name": "Agroasemex test copy 2",
		"icon": "/v1/accounts/accounts/AC-1111-2222/icon"
	},
	"recipients": {
		"users": [
			{
				"id": "USR-0000-0001",
				"href": "/accounts/users/USR-0000-0001",
				"name": "Will Smith"
			}
		],
		"userGroups": [
			{
				"id": "UGR-2459-0365",
				"href": "/accounts/user-groups/UGR-2459-0365",
				"name": "Administrators",
				"description": "Manages administrative tasks and resources within an organization.",
				"isDefault": true
			}
		]
	},
	"audit": {
		"created": {
			"at": "2023-12-15T10:17:11.179Z",
			"by": {
				"id": "USR-0000-0001",
				"href": "/accounts/users/USR-0000-0001",
				"name": "Will Smith"
			}
		},
		"updated": {
			"at": "2023-12-15T10:17:11.179Z",
			"by": {
				"id": "USR-0000-0001",
				"href": "/accounts/users/USR-0000-0001",
				"name": "Will Smith"
			}
		}
	}
}