Navigation: Catalog: Forms3 > Schemas

MarketingForms

Get a list of formsReturns a list of forms based on the search filters. By default, it returns the first 20 `hubspot` forms

Catalog: Forms3

Schema: Forms

Label: {res:itgen_hubspot_marketingforms_plural}

Retrieve: true

Insert: true

Update: false

Delete: false

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function MarketingForms. 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
after	string	☐		The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
archived	boolean	☐		Whether to return only results that have been archived.

Columns of Table Function

The columns of the table function MarketingForms are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert.

Name	Data Type	Label	Required	Documentation
archived	boolean	Archived	☐
archivedAt	datetime	Archived at	☐
configuration_allowLinkToResetKnownValues	boolean	{res:itgen_hubspot_configuration_allowlinktoresetknownvalues}	☐	Whether to add a reset link to the form. This removes any pre-populated content on the form and creates a new contact on submission.
configuration_archivable	boolean	{res:itgen_hubspot_configuration_archivable}	☐	Whether the form can be archived.
configuration_cloneable	boolean	{res:itgen_hubspot_configuration_cloneable}	☐	Whether the form can be cloned.
configuration_createNewContactForNewEmail	boolean	{res:itgen_hubspot_configuration_createnewcontactfornewemail}	☐	Whether to create a new contact when a form is submitted with an email address that doesn’t match any in your existing contacts records.
configuration_editable	boolean	{res:itgen_hubspot_configuration_editable}	☐	Whether the form can be edited.
configuration_language	string	{res:itgen_hubspot_configuration_language}	☐	The language of the form.
configuration_notifyContactOwner	boolean	{res:itgen_hubspot_configuration_notifycontactowner}	☐	Whether to send a notification email to the contact owner when a submission is received.
configuration_postSubmitAction_type	string	{res:itgen_hubspot_configuration_postsubmitaction_type}	☐	The action to take after submit. The default action is displaying a thank you message.
configuration_postSubmitAction_value	string	{res:itgen_hubspot_configuration_postsubmitaction_value}	☐	The thank you text or the page to redirect to.
configuration_prePopulateKnownValues	boolean	{res:itgen_hubspot_configuration_prepopulateknownvalues}	☐	Whether contact fields should pre-populate with known information when a contact returns to your site.
configuration_recaptchaEnabled	boolean	{res:itgen_hubspot_configuration_recaptchaenabled}	☐	Whether CAPTCHA (spam prevention) is enabled.
createdAt	datetime	Created at	☐
displayOptions_cssClass	string	{res:itgen_hubspot_displayoptions_cssclass}	☐
displayOptions_renderRawHtml	boolean	{res:itgen_hubspot_displayoptions_renderrawhtml}	☐	Whether the form will render as raw HTML as opposed to inside an iFrame.
displayOptions_style_backgroundWidth	string	{res:itgen_hubspot_displayoptions_style_backgroundwidth}	☐
displayOptions_style_fontFamily	string	{res:itgen_hubspot_displayoptions_style_fontfamily}	☐
displayOptions_style_helpTextColor	string	{res:itgen_hubspot_displayoptions_style_helptextcolor}	☐
displayOptions_style_helpTextSize	string	{res:itgen_hubspot_displayoptions_style_helptextsize}	☐
displayOptions_style_labelTextColor	string	{res:itgen_hubspot_displayoptions_style_labeltextcolor}	☐
displayOptions_style_labelTextSize	string	{res:itgen_hubspot_displayoptions_style_labeltextsize}	☐
displayOptions_style_legalConsentTextColor	string	{res:itgen_hubspot_displayoptions_style_legalconsenttextcolor}	☐
displayOptions_style_legalConsentTextSize	string	{res:itgen_hubspot_displayoptions_style_legalconsenttextsize}	☐
displayOptions_style_submitAlignment	string	{res:itgen_hubspot_displayoptions_style_submitalignment}	☐
displayOptions_style_submitColor	string	{res:itgen_hubspot_displayoptions_style_submitcolor}	☐
displayOptions_style_submitFontColor	string	{res:itgen_hubspot_displayoptions_style_submitfontcolor}	☐
displayOptions_style_submitSize	string	{res:itgen_hubspot_displayoptions_style_submitsize}	☐
displayOptions_submitButtonText	string	{res:itgen_hubspot_displayoptions_submitbuttontext}	☐	The text displayed on the form submit button.
displayOptions_theme	string	{res:itgen_hubspot_displayoptions_theme}	☐	The theme used for styling the input fields. This will not apply if the form is added to a HubSpot CMS page.
formType	string	{res:itgen_hubspot_formtype}	☐
id	string	ID	☐
legalConsentOptions_type	string	{res:itgen_hubspot_legalconsentoptions_type}	☐
name	string	Name	☐
updatedAt	datetime	Updated at	☐

18-12-2024 20:09 Version 24.1.33-BETA+5180

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

MarketingForms

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information