Navigation: Catalog: Meetings > Schemas

SchedulerVMeetingsMeetingLinksBook_CustomParamsLegalConsentOptionsCommunicationConsentCheckboxesBySlug

List booking informationGet details about the initial information necessary for a meeting scheduler.

Catalog: Meetings

Schema: Basic

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 SchedulerVMeetingsMeetingLinksBook_CustomParamsLegalConsentOptionsCommunicationConsentCheckboxesBySlug. 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
slug		☑
timezone		☑

Columns of Table Function

The columns of the table function SchedulerVMeetingsMeetingLinksBook_CustomParamsLegalConsentOptionsCommunicationConsentCheckboxesBySlug are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
availability	varchar2		☐	An array containing the closed range availability for a meeting link. Closed range times are provided as minute offsets from midnight (e.g., 540 corresponds to 9am).
brandingMetadata_accent2Color	varchar2		☐	The secondary accent color used in branding.
brandingMetadata_accentColor	varchar2		☐	The primary accent color used in branding.
brandingMetadata_companyAddressLine1	varchar2		☐	The first line of the company's address.
brandingMetadata_companyAddressLine2	varchar2		☐	The second line of the company's address.
brandingMetadata_companyAvatar	varchar2		☐	The URL of the company's avatar image.
brandingMetadata_companyCity	varchar2		☐	The city where the company is located.
brandingMetadata_companyCountry	varchar2		☐	The country where the company is located.
brandingMetadata_companyDomain	varchar2		☐	The domain of the company's website.
brandingMetadata_companyName	varchar2		☐	The name of the company.
brandingMetadata_companyState	varchar2		☐	The state where the company is located.
brandingMetadata_companyZip	varchar2		☐	The ZIP code of the company's location.
brandingMetadata_logoAltText	varchar2		☐	The alternative text for the current logo.
brandingMetadata_logoHeight	int32		☐	The height of the logo in pixels.
brandingMetadata_logoUrl	varchar2		☐	The URL of a custom logo image.
brandingMetadata_logoWidth	int32		☐	The width of the logo in pixels.
brandingMetadata_primaryColor	varchar2		☐	The primary color used in branding.
brandingMetadata_secondaryColor	varchar2		☐	The secondary color used in branding.
brandingMetadata_showMarketingAd	char		☐	Whether Hubspot Marketing ads are shown.
brandingMetadata_showSalesAd	char		☐	Whether Hubspot Sales ads are shown.
communicationConsentText	varchar2		☐	The text that describes the consent for communication preferences.
communicationTypeId	varchar2		☐	The ID of the communication consent form being recorded.
customAvailabilityEndDate	int64		☐	The end date for a meeting link's custom availability window, represented as Unix time in milliseconds.
customAvailabilityStartDate	int64		☐	The start date for a meeting link's custom availability window, represented as Unix time in milliseconds.
displayInfo_avatar	varchar2		☐	The URL of the user's custom uploaded avatar image.
displayInfo_companyAvatar	varchar2		☐	The URL of the company's avatar image.
displayInfo_headline	varchar2		☐	Deprecated field with no impact of link display info.
displayInfo_publicDisplayAvatarOption	varchar2		☐	Option for determining which avatar to display on scheduling page. Accepted values are: PROFILE_IMAGE, COMPANY_LOGO, CUSTOM_AVATAR,
durations	varchar2		☐
guestSettings_canAddGuests	char		☐	Indicates whether guests can be added to the meeting.
guestSettings_maxGuestCount	int32		☐	The maximum number of guests that can be added to the meeting.
isLegitimateInterest	char		☐	Whether the legal basis for processing is legitimate interest.
isOffline	char		☐	Whether the meeting was booked offline, meaning no associated calendar event was created.
label	varchar2	Label	☐	The text label describing the consent being given.
language	varchar2	Language	☐	The language setting used for the meeting link.
legalConsentEnabled	char		☐	Whether the legal consent checkbox is displayed during meeting booking.
legitimateInterestLegalBasis	varchar2		☐	The legal basis for processing under legitimate interest. Accepted values are: LEGITIMATE_INTEREST_PQL, LEGITIMATE_INTEREST_CLIENT, PERFORMANCE_OF_CONTRACT, CONSENT_WITH_NOTICE, NON_GDPR, PROCESS_AND_STORE, LEGITIMATE_INTEREST_OTHER.
legitimateInterestSubscriptionTypes	varchar2		☐
linkAvailability_hasMore	char		☐	Whether there are more available meeting times beyond the returned set.
linkAvailability_linkAvailabilityByDuration	varchar2		☐	Available booking slots for the meeting, grouped by the duration.
linkId	varchar2		☐	The unique identifier for the meeting link.
linkType	varchar2		☐	The type of the meeting link. Accepted values are: GROUP_CALENDAR, PERSONAL_LINK, ROUND_ROBIN_CALENDAR.
locale	varchar2		☐	The locale setting used for formatting dates and times in the meeting link.
location	varchar2		☐	The physical or virtual location where the meeting will take place.
meetingBufferTime	int64		☐	The minimum buffer time in milliseconds between consecutive meetings.
ownerPrioritized	char		☐	Indicates whether the meeting owner is prioritized during booking. Only applies to link types of ROUND_ROBIN.
privacyPolicyText	varchar2		☐	The text that describes the data processing privacy policy.
processingConsentCheckboxLabel	varchar2		☐	The label for the checkbox used to obtain consent for data processing.
processingConsentFooterText	varchar2		☐	The footer text accompanying the consent for data processing. This field is not used by the meeting platform and will always be empty.
processingConsentText	varchar2		☐	The text that describes the consent for processing personal data.
processingConsentType	varchar2		☐	The type of consent required for processing. Accepted values are: IMPLICIT, REQUIRED_CHECKBOX.
redirectUrl	varchar2		☐	The URL to redirect to after a meeting is booked.
required	char		☐	Whether the consent checkbox is required.
startTimeIncrementMinutes	varchar2		☐	The increment for available start times of meetings, spelt out as a word (e.g. 15 minute increment corresponds to `FIFTEEN`). `MEETING_DURATION` is also a valid value.
weeksToAdvertise	int32		☐	Legacy property that indicates the number of weeks in advance that availability is advertised. May be outdated or superseded by other properties.
welcomeScreenInfo_description	varchar2		☐	A brief description displayed the welcome screen below the title.
welcomeScreenInfo_logoUrl	varchar2		☐	The URL of the logo image to be displayed on the welcome screen, only used if `useCompanyLogo` is false.
welcomeScreenInfo_showWelcomeScreen	char		☐	Deprecated property. Value can be ignored but will always be false.
welcomeScreenInfo_title	varchar2		☐	The main heading displayed on the welcome screen.
welcomeScreenInfo_useCompanyLogo	char		☐	Whether the company's logo should be displayed on the welcome screen.

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.

Please enable JavaScript to view this site.

HubSpot API Data Model

SchedulerVMeetingsMeetingLinksBook_CustomParamsLegalConsentOptionsCommunicationConsentCheckboxesBySlug

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information