# Contact

The Contact object represents a contact who receives the notifications. 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:

<table><thead><tr><th width="170">Field Name</th><th width="121">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>A primary identifier for the contact. </p><p>Example: CTT-1234-9876-1234</p></td></tr><tr><td><code>href</code></td><td>string</td><td><p>A relative reference to the object. </p><p>Example: /v1/notifications/contacts/CTT-1234-9876-1234</p></td></tr><tr><td><code>name</code></td><td>string</td><td><p>The contact's display name.  </p><p>Example: Jane Doe</p></td></tr><tr><td><code>email</code></td><td>string</td><td><p>The contact's email address.  </p><p>Example: Jane@starkindustries.com</p></td></tr><tr><td><code>user</code></td><td>object (<a href="/pages/FPCTzWst4p8gyXQOzttt"><code>user</code></a>)</td><td><p>Indicates if the email belongs to a user registered on the platform. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "id": "USR-3773-5838",
  "href": "/accounts/users/USR-1234-9876",
  "name": "Will Smith",
  "email": "will.smith@softwareone.com"
}
</code></pre></td></tr><tr><td><code>optOuts</code></td><td>object (<a href="/pages/V1ox0ZYVCjxdL4bPr5rA"><code>category</code></a>)</td><td><p>A list of notification categories that the contact has chosen to opt out of. By default, a contact is opted into all published categories. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">[
  {
    "id": "NTC-1234-9876",
    "href": "/notifications/categories/NTC-1234-9876",
    "name": "Orders",
    "shortDescription": "Orders"
  }
]
</code></pre></td></tr><tr><td><code>status</code></td><td>enum</td><td>Allowed values:  <code>active</code>
 or <code>blocked</code>.</td></tr><tr><td><code>audit</code></td><td>object</td><td><p>A reference to the <a href="/pages/RnSJqP4ZqAW7vD2MWeVM"><code>audit</code></a> object. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">"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"
  }
}
</code></pre></td></tr></tbody></table>

## Example response

{% code lineNumbers="true" %}

```json
{
  "id": "CTT-1234-9876-1234",
  "href": "/v1/notifications/contacts/CTT-1234-9876-1234",
  "name": "Will Smith",
  "email": "will.smith@softwareone.com",
  "user": {
    "id": "USR-3773-5838",
    "href": "/accounts/users/USR-1234-9876",
    "name": "Will Smith",
    "email": "will.smith@softwareone.com"
  },
  "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"
      }
    }
  }
}
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.platform.softwareone.com/developer-resources/rest-api/notifications-api/contacts.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.