# CommunicationPreferenceUnsubscriptionStatusesBySubscriberId Retrieve a contact's unsubscribed status Check whether a contact has unsubscribed from all email subscriptions. If a contact has not opted out of all communications, the response `results` array will be empty. - Catalog: `Subscriptions` - Schema: `Status` This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `CommunicationPreferenceUnsubscriptionStatusesBySubscriberId`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `businessUnitId` | `` | ☐ | | The ID of the business unit. This is an optional integer parameter. | | `channel` | `` | ☑ | | The communication channel to unsubscribe from. Must be 'EMAIL'. (Values: EMAIL) | | `subscriberIdString` | `` | ☑ | | The unique identifier of the subscriber whose unsubscription status is being retrieved. | | `verbose` | `` | ☐ | | A boolean indicating whether to include detailed information in the response. Defaults to false. | ## Columns of Table Function The columns of the table function `CommunicationPreferenceUnsubscriptionStatusesBySubscriberId` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `businessUnitId` | `int64` | | ☐ | The ID of the business unit associated with the status. | | `channel` | `varchar2` | | ☐ | The type of communication channel, with 'EMAIL' as the only supported option. | | `status` | `varchar2` | Status | ☐ | The subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'. | | `subscriberIdString` | `varchar2` | | ☐ | The email address of the contact. | | `timestamp` | `datetime` | Timestamp | ☐ | The date and time when the status was recorded. | | `wideStatusType` | `varchar2` | | ☐ | The type of wide status, which can be 'PORTAL_WIDE' or 'BUSINESS_UNIT_WIDE'. |