Please enable JavaScript to view this site.

Made in EU
HubSpot Forums

HubSpot API Data Model

Navigation: Catalog: Subscriptions > Schemas > Schema: Status > Tables

CommunicationPreferenceUnsubscriptionStatusesBySubscriberId

Retrieve a contact's unsubscribed statusCheck 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'.

 

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer