Contact

The Contact object represents a contact to which notifications are sent. Contact can, but doesn’t have to be linked to a user on the platform. Each contact can manage its notification preferences on a category level.

This object contains the following attributes:

Field	Type	Description
id	string	A primary identifier for the contact. Example: CTT-1234-9876-1234
href	string	A relative reference to the object. Example: /v1/notifications/contacts/CTT-1234-9876-1234
name	string	The contact's display name. Example: Jane Doe
email	string	The contact's email address. Example: [email protected]
user	user	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": "[email protected]" }
optOuts	category	A list of notification categories that 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	The possible values are Active or Blocked.
audit	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

CONTACT OBJECT

{
  "id": "CTT-1234-9876-1234",
  "href": "/v1/notifications/contacts/CTT-1234-9876-1234",
  "name": "Will Smith",
  "email": "[email protected]",
  "user": {
    "id": "USR-3773-5838",
    "href": "/accounts/users/USR-1234-9876",
    "name": "Will Smith",
    "email": "[email protected]"
  },
  "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"
      }
    }
  }
}