MarketingFormById |
Get a form definitionReturns a form based on the form ID provided.
Catalog: Forms3
Schema: Forms
Label: {res:itgen_hubspot_marketingformbyid_plural}
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 MarketingFormById. 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 |
---|---|---|---|---|
archived |
boolean |
☐ |
|
Whether to return only results that have been archived. |
formId |
string |
☑ |
|
The unique identifier of the form |
Columns of Table Function
The columns of the table function MarketingFormById are shown below. Each column has an SQL data type.
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