> For the complete documentation index, see [llms.txt](https://docs.shortcutco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shortcutco.com/developers/api-reference/reference/objects/contact-preferences.md).

# The contact preferences object

The contact preferences object in the Shortcut API - every field, an example, and the endpoints that return it.

How a customer can be reached, and what they asked not to get.

## Fields

| Field                                              | Type                                   | Description                                                                                                                                                                                                         |
| -------------------------------------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `object`                                           | `"contact_preferences"`                | Always `contact_preferences`.                                                                                                                                                                                       |
| `customerId`                                       | id                                     | The customer.                                                                                                                                                                                                       |
| `textsOptedOut`                                    | boolean                                | Legacy linked-conversation opt-out flag. It may concern an older phone; compare textOptOutSources.currentPhone before interpreting the current number.                                                              |
| `textOptOutSources`                                | object                                 |                                                                                                                                                                                                                     |
| `textOptOutSources.currentPhone`                   | object or null                         | The normalized phone currently on this record and that phone's company-specific opt-out. Null when no usable phone is stored.                                                                                       |
| `textOptOutSources.currentPhone.optedOut`          | boolean                                | The stored opt-out flag; absence of an opt-out is not proof of consent or sendability.                                                                                                                              |
| `textOptOutSources.currentPhone.optedOutAt`        | timestamp or null                      | Latest recorded time for an active opt-out; null if no active dated opt-out is stored.                                                                                                                              |
| `textOptOutSources.currentPhone.phone`             | string                                 |                                                                                                                                                                                                                     |
| `textOptOutSources.linkedConversations`            | object                                 | An active opt-out on a conversation explicitly linked to this lead, or to this customer/its leads for a customer read. It can concern an older phone.                                                               |
| `textOptOutSources.linkedConversations.optedOut`   | boolean                                | The stored opt-out flag; absence of an opt-out is not proof of consent or sendability.                                                                                                                              |
| `textOptOutSources.linkedConversations.optedOutAt` | timestamp or null                      | Latest recorded time for an active opt-out; null if no active dated opt-out is stored.                                                                                                                              |
| `textOptOutSources.sourcesDiffer`                  | boolean or null                        | Whether current-phone and linked-conversation flags disagree; null without a usable current phone.                                                                                                                  |
| `emailSuppressionKinds`                            | array of `complaint`, `hard_bounce`    | Stored company-specific badges for the current email address, separate from category choices. Hard bounce is a recorded delivery fact, not a new universal hold. No kind present is not proof an email can be sent. |
| `email`                                            | string or null                         | The address emails go to; null when there is none that can get mail.                                                                                                                                                |
| `billingEmail`                                     | `enabled`, `disabled`, `unspecified`   | Invoices and receipts: `disabled` means they asked not to get them.                                                                                                                                                 |
| `serviceEmail`                                     | `enabled`, `disabled`, `unspecified`   | Visit reminders and service updates.                                                                                                                                                                                |
| `marketingEmail`                                   | `enabled`, `disabled`, `unspecified`   | Promotions; only the customer can turn these on.                                                                                                                                                                    |
| `portalAvailable`                                  | boolean                                | Whether the workspace's plan includes the customer portal.                                                                                                                                                          |
| `portalAccess`                                     | `none`, `invited`, `active`, `revoked` | Their access to the portal.                                                                                                                                                                                         |

## Example

```json
{
  "object": "contact_preferences",
  "customerId": "45aa5b54-41f4-469b-8e3e-d1e23a890d29",
  "textsOptedOut": true,
  "textOptOutSources": {
    "currentPhone": {
      "optedOut": true,
      "optedOutAt": null,
      "phone": "(406) 555-0142"
    },
    "linkedConversations": {
      "optedOut": true,
      "optedOutAt": null
    },
    "sourcesDiffer": true
  },
  "emailSuppressionKinds": [
    "complaint"
  ],
  "email": "robin.alvarez@example.com",
  "billingEmail": "enabled",
  "serviceEmail": "enabled",
  "marketingEmail": "enabled",
  "portalAvailable": true,
  "portalAccess": "none"
}
```

## Endpoints

| Endpoint                                     | What it does                      |
| -------------------------------------------- | --------------------------------- |
| `GET /v1/customers/{id}/contact-preferences` | Get how a customer can be reached |

## Lead contact preferences

How a customer can be reached, and what they asked not to get.

The answer of `GET /v1/leads/{id}/contact-preferences`.

| Field                                              | Type                                 | Description                                                                                                                                                                                                         |
| -------------------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `object`                                           | `"contact_preferences"`              | Always `contact_preferences`.                                                                                                                                                                                       |
| `textsOptedOut`                                    | boolean                              | Legacy linked-conversation opt-out flag. It may concern an older phone; compare textOptOutSources.currentPhone before interpreting the current number.                                                              |
| `textOptOutSources`                                | object                               |                                                                                                                                                                                                                     |
| `textOptOutSources.currentPhone`                   | object or null                       | The normalized phone currently on this record and that phone's company-specific opt-out. Null when no usable phone is stored.                                                                                       |
| `textOptOutSources.currentPhone.optedOut`          | boolean                              | The stored opt-out flag; absence of an opt-out is not proof of consent or sendability.                                                                                                                              |
| `textOptOutSources.currentPhone.optedOutAt`        | timestamp or null                    | Latest recorded time for an active opt-out; null if no active dated opt-out is stored.                                                                                                                              |
| `textOptOutSources.currentPhone.phone`             | string                               |                                                                                                                                                                                                                     |
| `textOptOutSources.linkedConversations`            | object                               | An active opt-out on a conversation explicitly linked to this lead, or to this customer/its leads for a customer read. It can concern an older phone.                                                               |
| `textOptOutSources.linkedConversations.optedOut`   | boolean                              | The stored opt-out flag; absence of an opt-out is not proof of consent or sendability.                                                                                                                              |
| `textOptOutSources.linkedConversations.optedOutAt` | timestamp or null                    | Latest recorded time for an active opt-out; null if no active dated opt-out is stored.                                                                                                                              |
| `textOptOutSources.sourcesDiffer`                  | boolean or null                      | Whether current-phone and linked-conversation flags disagree; null without a usable current phone.                                                                                                                  |
| `emailSuppressionKinds`                            | array of `complaint`, `hard_bounce`  | Stored company-specific badges for the current email address, separate from category choices. Hard bounce is a recorded delivery fact, not a new universal hold. No kind present is not proof an email can be sent. |
| `email`                                            | string or null                       | The address emails go to; null when there is none that can get mail.                                                                                                                                                |
| `billingEmail`                                     | `enabled`, `disabled`, `unspecified` | Invoices and receipts: `disabled` means they asked not to get them.                                                                                                                                                 |
| `serviceEmail`                                     | `enabled`, `disabled`, `unspecified` | Visit reminders and service updates.                                                                                                                                                                                |
| `marketingEmail`                                   | `enabled`, `disabled`, `unspecified` | Promotions; only the customer can turn these on.                                                                                                                                                                    |
| `leadId`                                           | id                                   | The lead whose current contact fields and explicitly linked conversations were read.                                                                                                                                |

```json
{
  "object": "contact_preferences",
  "textsOptedOut": true,
  "textOptOutSources": {
    "currentPhone": {
      "optedOut": true,
      "optedOutAt": null,
      "phone": "(406) 555-0142"
    },
    "linkedConversations": {
      "optedOut": true,
      "optedOutAt": null
    },
    "sourcesDiffer": true
  },
  "emailSuppressionKinds": [
    "complaint"
  ],
  "email": "robin.alvarez@example.com",
  "billingEmail": "enabled",
  "serviceEmail": "enabled",
  "marketingEmail": "enabled",
  "leadId": "b76e245e-b3b8-4fa5-8002-9aecac4cd633"
}
```
