Contact

The Contact object represents a contact who receives the notifications. Contact can be linked to a user in the platform. Each contact can manage its notification preferences at the category level.

This object contains the following attributes:

Field	Type	Description
id	string, core	(Read-only) A primary identifier for the contact.
href	string, core	(Read-only) A relative reference to the object.
name	string, core	The display name of the contact.
email	string, core	The email address of the contact.
user	object, core	(Read-only) Indicates if the email belongs to a user registered on the platform. Example: { "id": "USR-3773-5838", "href": "/accounts/users/USR-1234-9876", "name": "Will Smith", "email": "[e-mail]" }
optOuts	object	Represents the category object, containing the list of notification categories the contact has chosen to opt out of. By default, a contact is opted into all published categories. Example: [ { "id": "NTC-1234-9876", "href": "/notifications/categories/NTC-1234-9876", "name": "Orders", "shortDescription": "Orders" } ]
status	enum	Indicates the status. Allowed values are active or blocked.
audit	object	(Read-only) Represents the audit object.

Example

CONTACT OBJECT

{
  "id": "CTT-1234-9876-1234",
  "href": "/v1/notifications/contacts/CTT-1234-9876-1234",
  "name": "Will Smith",
  "email": "[e-mail]",
  "user": {
    "id": "USR-3773-5838",
    "href": "/accounts/users/USR-1234-9876",
    "name": "Will Smith",
    "email": "[e-mail]"
  },
  "optOuts": [
    {
      "id": "NTC-1234-9876",
      "href": "/notifications/categories/NTC-1234-9876",
      "name": "Orders",
      "shortDescription": "Orders"
    }
  ],
  "status": "Active",
  "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"
      }
    }
  }
}