curl --request GET \
--url https://api.hubapi.com/marketing/v3/forms/{formId} \
--header 'Authorization: Bearer <token>'{
"id": "6eae0163-5362-4c0e-809c-b99a18678adc",
"name": "Register for updates",
"createdAt": "2020-09-22T05:12:27.505Z",
"updatedAt": "2020-09-22T07:17:31.627Z",
"archived": false,
"fieldGroups": [
{
"groupType": "default_group",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "email",
"label": "Email",
"required": true,
"hidden": false,
"fieldType": "email",
"validation": {
"blockedEmailDomains": [],
"useDefaultBlockList": false
}
}
]
},
{
"groupType": "default_group",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "firstname",
"label": "First name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
},
{
"objectTypeId": "0-1",
"name": "lastname",
"label": "Last name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
}
]
}
],
"configuration": {
"language": "en",
"cloneable": true,
"postSubmitAction": {
"type": "thank_you",
"value": "Thanks for submitting the form."
},
"editable": true,
"archivable": true,
"recaptchaEnabled": true,
"notifyContactOwner": false,
"notifyRecipients": [
"2886602"
],
"createNewContactForNewEmail": false,
"prePopulateKnownValues": true,
"allowLinkToResetKnownValues": false,
"lifecycleStages": [
{
"objectTypeId": "0-1",
"value": "subscriber"
},
{
"objectTypeId": "0-2",
"value": "subscriber"
}
]
},
"displayOptions": {
"renderRawHtml": false,
"theme": "default_style",
"submitButtonText": "Submit",
"style": {
"fontFamily": "arial, helvetica, sans-serif",
"backgroundWidth": "100%",
"labelTextColor": "#33475b",
"labelTextSize": "13px",
"helpTextColor": "#7C98B6",
"helpTextSize": "11px",
"legalConsentTextColor": "#33475b",
"legalConsentTextSize": "14px",
"submitColor": "#ff7a59",
"submitAlignment": "left",
"submitFontColor": "#ffffff",
"submitSize": "12px"
},
"cssClass": "hs-form stacked"
},
"legalConsentOptions": {
"type": "explicit_consent_to_process",
"communicationConsentText": "<p>Fancy Forms, LLC is committed to protecting and respecting your privacy, and we’ll only use your personal information to administer your account and to provide the products and services you requested from us. From time to time, we would like to contact you about our products and services, as well as other content that may be of interest to you. If you consent to us contacting you for this purpose, please tick below to say how you would like us to contact you:</p>",
"communicationsCheckboxes": [
{
"required": false,
"subscriptionTypeId": 3883363,
"label": "<p>I agree to receive other communications from Fancy Forms, LLC.</p>"
}
],
"consentToProcessText": "<p>In order to provide you the content requested, we need to store and process your personal data. If you consent to us storing your personal data for this purpose, please tick the checkbox below.</p>",
"consentToProcessCheckboxLabel": "<p>I agree to allow Fancy Forms, LLC to store and process my personal data.</p>",
"privacyText": "<p>You can unsubscribe from these communications at any time. For more information on how to unsubscribe, our privacy practices, and how we are committed to protecting and respecting your privacy, please review our Privacy Policy.</p>"
},
"formType": "hubspot"
}Renvoie un formulaire basé sur l’ID de formulaire fourni.
curl --request GET \
--url https://api.hubapi.com/marketing/v3/forms/{formId} \
--header 'Authorization: Bearer <token>'{
"id": "6eae0163-5362-4c0e-809c-b99a18678adc",
"name": "Register for updates",
"createdAt": "2020-09-22T05:12:27.505Z",
"updatedAt": "2020-09-22T07:17:31.627Z",
"archived": false,
"fieldGroups": [
{
"groupType": "default_group",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "email",
"label": "Email",
"required": true,
"hidden": false,
"fieldType": "email",
"validation": {
"blockedEmailDomains": [],
"useDefaultBlockList": false
}
}
]
},
{
"groupType": "default_group",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "firstname",
"label": "First name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
},
{
"objectTypeId": "0-1",
"name": "lastname",
"label": "Last name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
}
]
}
],
"configuration": {
"language": "en",
"cloneable": true,
"postSubmitAction": {
"type": "thank_you",
"value": "Thanks for submitting the form."
},
"editable": true,
"archivable": true,
"recaptchaEnabled": true,
"notifyContactOwner": false,
"notifyRecipients": [
"2886602"
],
"createNewContactForNewEmail": false,
"prePopulateKnownValues": true,
"allowLinkToResetKnownValues": false,
"lifecycleStages": [
{
"objectTypeId": "0-1",
"value": "subscriber"
},
{
"objectTypeId": "0-2",
"value": "subscriber"
}
]
},
"displayOptions": {
"renderRawHtml": false,
"theme": "default_style",
"submitButtonText": "Submit",
"style": {
"fontFamily": "arial, helvetica, sans-serif",
"backgroundWidth": "100%",
"labelTextColor": "#33475b",
"labelTextSize": "13px",
"helpTextColor": "#7C98B6",
"helpTextSize": "11px",
"legalConsentTextColor": "#33475b",
"legalConsentTextSize": "14px",
"submitColor": "#ff7a59",
"submitAlignment": "left",
"submitFontColor": "#ffffff",
"submitSize": "12px"
},
"cssClass": "hs-form stacked"
},
"legalConsentOptions": {
"type": "explicit_consent_to_process",
"communicationConsentText": "<p>Fancy Forms, LLC is committed to protecting and respecting your privacy, and we’ll only use your personal information to administer your account and to provide the products and services you requested from us. From time to time, we would like to contact you about our products and services, as well as other content that may be of interest to you. If you consent to us contacting you for this purpose, please tick below to say how you would like us to contact you:</p>",
"communicationsCheckboxes": [
{
"required": false,
"subscriptionTypeId": 3883363,
"label": "<p>I agree to receive other communications from Fancy Forms, LLC.</p>"
}
],
"consentToProcessText": "<p>In order to provide you the content requested, we need to store and process your personal data. If you consent to us storing your personal data for this purpose, please tick the checkbox below.</p>",
"consentToProcessCheckboxLabel": "<p>I agree to allow Fancy Forms, LLC to store and process my personal data.</p>",
"privacyText": "<p>You can unsubscribe from these communications at any time. For more information on how to unsubscribe, our privacy practices, and how we are committed to protecting and respecting your privacy, please review our Privacy Policy.</p>"
},
"formType": "hubspot"
}Produits pris en charge
Portées requises
The access token received from the authorization server in the OAuth 2.0 flow.
L'identificateur unique du formulaire
S'il faut renvoyer uniquement les résultats qui ont été archivés.
successful operation
hubspot Afficher attributs enfants
Les champs de formulaire inclus dans le groupe
A form field used for collecting an email address.
Afficher attributs enfants
Une liste d'autres champs à rendre visibles en fonction de la valeur remplie pour ce champ.
Afficher attributs enfants
A condition based on customer input
Afficher attributs enfants
between, contains, doesnt_contain, eq, gt, gte, is_not_empty, lt, lte, neq, not_between, set_all, set_any, set_eq, set_neq, set_not_all, set_not_any, str_ends_with, str_starts_with, within_time, within_time_reverse A form field used for collecting a phone number.
Afficher attributs enfants
Une liste d'autres champs à rendre visibles en fonction de la valeur remplie pour ce champ.
Détermine comment le champ sera affiché et validé.
phone Si le champ doit être caché ou non. Les champs cachés n'apparaîtront pas sur le formulaire, mais peuvent être utilisés pour transmettre une valeur à une propriété sans que le client ait à la remplir.
Le libellé principal pour le champ de formulaire.
L'identifiant du champ. En combinaison avec l'ID du type d'objet, il doit être unique.
Un ID unique pour le type d'objet du CRM de ce champ. Par exemple, un champ CONTACT aura l'identifiant de type d'objet 0-1.
Si une valeur de ce champ est requise lors de la soumission du formulaire.
Afficher ou non un menu déroulant du code pays à côté du champ de téléphone.
La valeur remplie par défaut. Cette valeur sera soumise à moins que le client ne la modifie.
Texte supplémentaire aidant le client à compléter le champ.
Le texte de requête s'affiche lorsque le champ n'est pas rempli.
Détermine comment le champ sera affiché et validé.
email Si le champ doit être caché ou non. Les champs cachés n'apparaîtront pas sur le formulaire, mais peuvent être utilisés pour transmettre une valeur à une propriété sans que le client ait à la remplir.
Le libellé principal pour le champ de formulaire.
L'identifiant du champ. En combinaison avec l'ID du type d'objet, il doit être unique.
Un ID unique pour le type d'objet du CRM de ce champ. Par exemple, un champ CONTACT aura l'identifiant de type d'objet 0-1.
Si une valeur de ce champ est requise lors de la soumission du formulaire.
Describes how an email address should be validated.
La valeur remplie par défaut. Cette valeur sera soumise à moins que le client ne la modifie.
Texte supplémentaire aidant le client à compléter le champ.
Le texte de requête s'affiche lorsque le champ n'est pas rempli.
default_group, progressive, queued Le type de texte enrichi inclus. La valeur par défaut est texte.
image, text Un bloc de texte enrichi ou une image. Ceux-ci peuvent être utilisés pour ajouter des informations supplémentaires aux clients remplissant le formulaire. Si le groupe de champs inclut des champs, le texte enrichi sera affiché avant les champs.
Afficher attributs enfants
S'il faut ajouter un lien de réinitialisation au formulaire. Cela supprime tout contenu pré-rempli du formulaire et crée un nouveau contact lors de la soumission.
Si le formulaire peut être archivé.
Si le formulaire peut être cloné.
S'il faut créer un nouveau contact lorsqu'un formulaire est soumis avec une adresse e-mail qui ne correspond à aucune de vos fiches d'informations de contacts existantes.
Si le formulaire peut être modifié.
La langue du formulaire.
af, ar-eg, bg, bn, ca-es, cs, da, de, el, en, es, es-mx, fi, fr, fr-ca, he-il, hr, hu, id, it, ja, ko, lt, ms, nl, no-no, pl, pt, pt-br, ro, ru, sk, sl, sv, th, tl, tr, uk, vi, zh-cn, zh-hk, zh-tw S'il faut envoyer un e-mail de notification au propriétaire du contact lorsqu'une soumission est reçue.
La liste des ID d'utilisateurs devant recevoir un e-mail de notification lors de la réception d'une soumission.
What should happen after the customer submits the form.
Afficher attributs enfants
L'action à entreprendre après la soumission. L'action par défaut est d'afficher un message de remerciement.
redirect_url, thank_you Le texte de remerciement ou la page vers laquelle rediriger.
Si les champs de contact doivent être pré-remplit avec des informations connues lorsqu'un contact revient sur votre site.
Si le CAPTCHA (prévention du spam) est activé.
Options for styling the form.
Afficher attributs enfants
Si le formulaire s'affichera en HTML brut plutôt que dans un iFrame.
Styling options for the form
Afficher attributs enfants
center, left, right Le texte affiché sur le bouton de soumission du formulaire.
Le thème utilisé pour styliser les champs de saisie. Cela ne s'appliquera pas si le formulaire est ajouté à une page HubSpot CMS.
canvas, default_style, legacy, linear, round, sharp