> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.de/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update a form definition > Aktualisieren Sie alle Felder einer Hubspot-Formulardefinition. export const ScopesList = ({scopes = [], description = "Diese API erfordert einen der folgenden Bereiche:"}) => { if (!scopes || scopes.length === 0) { return null; } const sortedScopes = scopes.sort((a, b) => a.localeCompare(b)); return
{description}
{sortedScopes.map((scope, index) =>
{scope}
)}
; }; export const SupportedProducts = ({marketing, sales, service, cms, marketingLevel, salesLevel, serviceLevel, cmsLevel}) => { const translations = { header: "Unterstützte Produkte", description: "Erfordert eines der folgenden Produkte oder höher.", productNames: { marketing: "Marketing Hub", sales: "Sales Hub", service: "Service Hub", cms: "Content Hub" }, tiers: { free: "Kostenlos", starter: "Starter", professional: "Professional", enterprise: "Enterprise" } }; const translateTier = tier => { if (!tier) return ''; const lowerTier = tier.toLowerCase(); return translations.tiers[lowerTier] || tier; }; const products = [{ name: marketing ? translations.productNames.marketing : '', level: translateTier(marketingLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg", alt: "Marketing Hub" }, { name: sales ? translations.productNames.sales : '', level: translateTier(salesLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg", alt: "Sales Hub" }, { name: service ? translations.productNames.service : '', level: translateTier(serviceLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg", alt: "Service Hub" }, { name: cms ? translations.productNames.cms : '', level: translateTier(cmsLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg", alt: "Content Hub" }].filter(product => product.name && product.level); if (products.length === 0) return null; return
{translations.description}
{products.map((product, index) =>
{product.alt} {product.name} - {product.level}
)}
; }; ## OpenAPI ````yaml specs/legacy/v3/marketing-forms-v3.json PUT /marketing/v3/forms/{formId} openapi: 3.0.1 info: title: Formulare description: Basepom for all HubSpot Projects version: v3 x-hubspot-product-tier-requirements: marketing: FREE sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE x-hubspot-api-use-case: "Zur programmgesteuerten Änderung bestimmter Teile eines HubSpot-Formulars auf der Grundlage von komplexeren Anwendungsfällen oder Daten von Drittanbietern (um z.\_B. dynamisch Felder auf der Grundlage von Daten anzuzeigen, die von einer externen Quelle abgefragt werden)." x-hubspot-related-documentation: - name: Forms Guide url: https://developers.hubspot.com/docs/guides/api/marketing/forms x-hubspot-introduction: >- Verwenden Sie die Formular-API, um Formulare in Ihrem HubSpot-Account zu erstellen und zu verwalten, die Sie dann auf Ihrer Website einbetten können, um Formularübermittlungen von Website-Besuchern zu erfassen. servers: - url: https://api.hubapi.com security: [] tags: - name: Basic paths: /marketing/v3/forms/{formId}: put: tags: - Basic summary: Eine Formulardefinition aktualisieren description: Aktualisieren Sie alle Felder einer Hubspot-Formulardefinition. operationId: put-/marketing/v3/forms/{formId}_replace parameters: - name: formId in: path description: '' required: true style: simple explode: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/HubSpotFormDefinition' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/FormDefinitionBase' default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - forms components: schemas: HubSpotFormDefinition: required: - archived - configuration - createdAt - displayOptions - fieldGroups - formType - id - legalConsentOptions - name - updatedAt type: object properties: archived: type: boolean archivedAt: type: string format: date-time configuration: $ref: '#/components/schemas/HubSpotFormConfiguration' createdAt: type: string format: date-time displayOptions: $ref: '#/components/schemas/FormDisplayOptions' fieldGroups: type: array items: $ref: '#/components/schemas/FieldGroup' formType: type: string default: hubspot enum: - hubspot id: type: string legalConsentOptions: oneOf: - $ref: '#/components/schemas/LegalConsentOptionsNone' - $ref: '#/components/schemas/LegalConsentOptionsLegitimateInterest' - $ref: '#/components/schemas/LegalConsentOptionsExplicitConsentToProcess' - $ref: '#/components/schemas/LegalConsentOptionsImplicitConsentToProcess' name: type: string updatedAt: type: string format: date-time x-hubspot-sub-type-impl: true FormDefinitionBase: properties: {} oneOf: - $ref: '#/components/schemas/HubSpotFormDefinition' HubSpotFormConfiguration: required: - allowLinkToResetKnownValues - archivable - cloneable - createNewContactForNewEmail - editable - language - lifecycleStages - notifyContactOwner - notifyRecipients - postSubmitAction - prePopulateKnownValues - recaptchaEnabled type: object properties: allowLinkToResetKnownValues: type: boolean description: >- Ob ein Link zum Zurücksetzen des Formulars hinzugefügt werden soll. Dadurch werden alle vorab ausgefüllten Inhalte im Formular entfernt und bei der Einsendung ein neuer Kontakt erstellt. archivable: type: boolean description: Ob das Formular archiviert werden kann. cloneable: type: boolean description: Ob das Formular geklont werden kann. createNewContactForNewEmail: type: boolean description: >- Ob ein neuer Kontakt erstellt werden soll, wenn das Formular mit einer E-Mail-Adresse eingesendet wird, die mit keiner in Ihren vorhandenen Kontaktdatensätzen übereinstimmt. editable: type: boolean description: Ob das Formular bearbeitet werden kann. embedType: type: string enum: - V3 - V4 language: type: string description: Die Sprache des Formulars. enum: - af - ar-eg - bg - bn - ca-es - cs - da - de - el - en - en-gb - 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 lifecycleStages: type: array items: $ref: '#/components/schemas/LifecycleStage' notifyContactOwner: type: boolean description: >- Ob eine Benachrichtigung per E-Mail an den für den Kontakt zuständigen Mitarbeiter gesendet werden soll, wenn eine Einsendung erfolgt ist. notifyRecipients: type: array description: >- Die Liste der Benutzer-IDs, die eine E-Mail-Benachrichtigung erhalten sollen, wenn eine Einsendung erfolgt ist. items: type: string postSubmitAction: $ref: '#/components/schemas/FormPostSubmitAction' prePopulateKnownValues: type: boolean description: >- Ob Kontaktfelder vorab mit bekannten Informationen ausgefüllt werden sollen, wenn ein Kontakt zu Ihrer Website zurückkehrt. recaptchaEnabled: type: boolean description: Ob Captcha (Spamschutz) aktiviert ist. FormDisplayOptions: required: - renderRawHtml - style - submitButtonText - theme type: object properties: cssClass: type: string description: >- Name(n) der benutzerdefinierten CSS-Klasse(n) zum Anwenden auf das Formularelement für zusätzliche Formatierung. renderRawHtml: type: boolean description: >- Ob das Formular als unformatierte HTML anstatt innerhalb eines iFrames dargestellt wird. style: $ref: '#/components/schemas/FormStyle' submitButtonText: type: string description: Der Text, der auf dem Button zur Formulareinsendung angezeigt wird. theme: type: string description: >- Das für die Gestaltung der Eingabefelder verwendete Design. Wird nicht angewendet, wenn das Formular zu einer CMS Hub-Seite hinzugefügt wird. enum: - canvas - default_style - legacy - linear - round - sharp FieldGroup: required: - fields - groupType - richTextType type: object properties: fields: type: array description: Die in der Gruppe enthaltenen Formularfelder items: oneOf: - $ref: '#/components/schemas/EmailField' - $ref: '#/components/schemas/PhoneField' - $ref: '#/components/schemas/MobilePhoneField' - $ref: '#/components/schemas/SingleLineTextField' - $ref: '#/components/schemas/MultiLineTextField' - $ref: '#/components/schemas/NumberField' - $ref: '#/components/schemas/SingleCheckboxField' - $ref: '#/components/schemas/MultipleCheckboxesField' - $ref: '#/components/schemas/DropdownField' - $ref: '#/components/schemas/RadioField' - $ref: '#/components/schemas/DatepickerField' - $ref: '#/components/schemas/FileField' - $ref: '#/components/schemas/PaymentLinkRadioField' groupType: type: string description: >- Der Typ der Feldgruppierung. Werte: default_group (Standardfelder), progressive und queued. enum: - default_group - progressive - queued richText: type: string description: >- Ein Rich-Text-Block oder ein Bild. Zum Hinzufügen zusätzlicher Informationen für die Kunden, die das Formular ausfüllen. Wenn die Feldgruppe Felder enthält, wird der Rich-Text vor den Feldern angezeigt. richTextType: type: string description: >- Der Typ des enthaltenen Rich-Textes. Der Standardwert ist Text. Werte: text, image. enum: - image - text LegalConsentOptionsNone: title: none required: - type type: object properties: type: type: string description: >- Typ der rechtlichen Einwilligung. „none“ bedeutet, dass für dieses Formular keine Konfiguration für die rechtliche Einwilligung erforderlich ist. default: none enum: - none x-hubspot-sub-type-impl: true LegalConsentOptionsLegitimateInterest: title: legitimate_interest required: - lawfulBasis - privacyText - subscriptionTypeIds - type type: object properties: lawfulBasis: type: string description: >- Die rechtliche Basis für die Verarbeitung von Daten aufgrund berechtigten Interesses. Werte: lead (Verarbeitung von Daten zur Leadgenerierung), client (Verarbeitung von Daten vorhandener Kunden), other (sonstiges berechtigtes Interesse). Standard: lead. enum: - client - lead - other privacyText: type: string description: >- Text zur Erläuterung der Datenschutzrichtlinie und der Praktiken zum Umgang mit Daten. subscriptionTypeIds: type: array items: type: integer format: int64 type: type: string description: Typ der rechtlichen Einwilligung. default: legitimate_interest enum: - legitimate_interest x-hubspot-sub-type-impl: true LegalConsentOptionsExplicitConsentToProcess: title: explicit_consent_to_process required: - communicationsCheckboxes - privacyText - type type: object properties: communicationConsentText: type: string description: >- Text zur Erläuterung der Einstellungen hinsichtlich der Einwilligung zur Kommunikation. Informiert Benutzer darüber, wie ihre Kontaktdaten für die Kommunikation verwendet werden. communicationsCheckboxes: type: array items: $ref: '#/components/schemas/LegalConsentCheckbox' consentToProcessCheckboxLabel: type: string description: >- Labeltext für das Kontrollkästchen für die Einwilligung zur Verarbeitung. consentToProcessFooterText: type: string description: Footer-Text für den Abschnitt für die Einwilligung zur Verarbeitung. consentToProcessText: type: string description: >- Text zur Erläuterung der Einwilligung zur Verarbeitung personenbezogener Daten. privacyText: type: string description: >- Text zur Erläuterung der Datenschutzrichtlinie und der Praktiken zum Umgang mit Daten. Pflichtfeld, das Benutzer über ihre Datenschutzrechte und den Schutz ihrer Daten informiert. type: type: string description: Typ der rechtlichen Einwilligung. default: explicit_consent_to_process enum: - explicit_consent_to_process x-hubspot-sub-type-impl: true LegalConsentOptionsImplicitConsentToProcess: title: implicit_consent_to_process required: - communicationsCheckboxes - privacyText - type type: object properties: communicationConsentText: type: string description: >- Text zur Erläuterung der Einstellungen hinsichtlich der Einwilligung zur Kommunikation. communicationsCheckboxes: type: array items: $ref: '#/components/schemas/LegalConsentCheckbox' consentToProcessText: type: string description: >- Text zur Erläuterung der Einwilligung zur Verarbeitung personenbezogener Daten. privacyText: type: string description: >- Text zur Erläuterung der Datenschutzrichtlinie und der Praktiken zum Umgang mit Daten. type: type: string description: Typ der rechtlichen Einwilligung. default: implicit_consent_to_process enum: - implicit_consent_to_process x-hubspot-sub-type-impl: true Error: required: - category - correlationId - message type: object properties: category: type: string description: Die Fehlerkategorie context: type: object additionalProperties: type: array items: type: string description: Kontext zur Fehlerbedingung example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Eine eindeutige ID für die Anfrage. Berücksichtigen Sie diesen Wert in Fehlerberichten oder Support-Tickets. format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: Weitere Informationen zum Fehler items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Eine Zuordnung der Namen von Links zu zugeordneten URIs mit einer Dokumentation zum Fehler oder empfohlenen Abhilfemaßnahmen message: type: string description: >- Eine für Menschen lesbare Nachricht mit einer Beschreibung des Fehlers und ggf. Abhilfemaßnahmen example: An error occurred subCategory: type: string description: Eine spezifische Kategorie, die genauere Details zum Fehler enthält example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base LifecycleStage: required: - objectTypeId - value type: object properties: objectTypeId: type: string description: Die „objectTypeId“ für Kontakt und Unternehmen value: type: string description: >- Der interne Name der Lifecycle-Phase des Kontakts, wird beim Einsenden eines Formulars festgelegt FormPostSubmitAction: required: - type - value type: object properties: type: type: string description: >- Die Aktion, die nach dem Einsenden erfolgen soll. Standardmäßig wird eine Danksagung angezeigt. enum: - redirect_url - thank_you value: type: string description: Der Danksagungstext oder die Weiterleitungsseite. FormStyle: required: - backgroundWidth - fontFamily - helpTextColor - helpTextSize - labelTextColor - labelTextSize - legalConsentTextColor - legalConsentTextSize - submitAlignment - submitColor - submitFontColor - submitSize type: object properties: backgroundWidth: type: string description: "Die Breite des Hintergrunds für Formular. Zulässig: Prozentangaben (z.\_B. 100\_%) oder Pixelwerte (z.\_B. 600\_Pixel)." fontFamily: type: string description: "Schriftfamilie für das gesamte Formular (z.\_B. Arial, Helvetica, Sans Serif)." helpTextColor: type: string description: >- Hexadezimalwert für den Hilfetext, der unter Formularfeldern angezeigt wird. helpTextSize: type: string description: "Schriftgröße für Hilfetext. Zulässig: Pixelwerte (z.\_B. 11\_Pixel)." labelTextColor: type: string description: Hexadezimalwert für Feldlabel. labelTextSize: type: string description: "Schriftgröße für Feldlabel. Zulässig: Pixelwerte (z.\_B. 11\_Pixel)." legalConsentTextColor: type: string description: Hexadezimalwert für Text für rechtliche Einwilligung. legalConsentTextSize: type: string description: "Schriftgröße für Text für rechtliche Einwilligung. Zulässig: Pixelwerte (z.\_B. 14\_Pixel)." submitAlignment: type: string description: >- Horizontale Ausrichtung für Einsende-Button. Werte: left, center, right. enum: - center - left - right submitColor: type: string description: Hexadezimalwert für Hintergrund des Einsende-Buttons. submitFontColor: type: string description: Hexadezimalwert für Text des Einsende-Buttons. submitSize: type: string description: "Schriftgröße für Text des Einsende-Buttons. Zulässig: Pixelwerte (z.\_B. 12\_Pixel)." EmailField: title: email required: - dependentFields - fieldType - hidden - label - name - objectTypeId - required - validation type: object properties: defaultValue: type: string description: >- Der Wert, der standardmäßig angegeben wird. Dieser Wert wird übermittelt, wenn der Kunde ihn nicht ändert. dependentFields: type: array description: >- Eine Liste sonstiger Felder, die basierend auf dem für dieses Feld eingegebenen Wert sichtbar gemacht werden sollen. items: $ref: '#/components/schemas/DependentField' description: type: string description: >- Zusätzlicher Text als Hilfestellung für den Kunden zum Ausfüllen des Felds. fieldType: type: string description: Legt fest, wie das Feld angezeigt und validiert werden soll. default: email enum: - email hidden: type: boolean description: >- Ob ein Feld ausgeblendet werden soll oder nicht. Ausgeblendete Felder werden nicht im Formular angezeigt, können jedoch verwendet werden, um einen Wert an eine Eigenschaft zu übergeben, ohne dass der Kunde etwas ausfüllen muss. label: type: string description: Das Haupt-Label für das Formularfeld. name: type: string description: >- Die ID des Feldes. In Kombination mit der Objekttyp-ID muss diese eindeutig sein. objectTypeId: type: string description: >- Eine eindeutige ID für den CRM-Objekttyp dieses Feldes. Ein KONTAKT-Feld hat zum Beispiel die Objekttyp-ID 0-1. placeholder: type: string description: Der angezeigte Prompt-Text, sofern das Feld nicht ausgefüllt ist. required: type: boolean description: >- Ob ein Wert für dieses Feld beim Absenden des Formulars erforderlich ist. validation: $ref: '#/components/schemas/EmailFieldValidation' x-hubspot-sub-type-impl: true PhoneField: title: phone required: - dependentFields - fieldType - hidden - label - name - objectTypeId - required - useCountryCodeSelect - validation type: object properties: defaultValue: type: string description: >- Der Wert, der standardmäßig angegeben wird. Dieser Wert wird übermittelt, wenn der Kunde ihn nicht ändert. dependentFields: type: array description: >- Eine Liste sonstiger Felder, die basierend auf dem für dieses Feld eingegebenen Wert sichtbar gemacht werden sollen. items: $ref: '#/components/schemas/DependentField' description: type: string description: >- Zusätzlicher Text als Hilfestellung für den Kunden zum Ausfüllen des Felds. fieldType: type: string description: Legt fest, wie das Feld angezeigt und validiert werden soll. default: phone enum: - phone hidden: type: boolean description: >- Ob ein Feld ausgeblendet werden soll oder nicht. Ausgeblendete Felder werden nicht im Formular angezeigt, können jedoch verwendet werden, um einen Wert an eine Eigenschaft zu übergeben, ohne dass der Kunde etwas ausfüllen muss. label: type: string description: Das Haupt-Label für das Formularfeld. name: type: string description: >- Die ID des Feldes. In Kombination mit der Objekttyp-ID muss diese eindeutig sein. objectTypeId: type: string description: >- Eine eindeutige ID für den CRM-Objekttyp dieses Feldes. Ein KONTAKT-Feld hat zum Beispiel die Objekttyp-ID 0-1. placeholder: type: string description: Der angezeigte Prompt-Text, sofern das Feld nicht ausgefüllt ist. required: type: boolean description: >- Ob ein Wert für dieses Feld beim Absenden des Formulars erforderlich ist. useCountryCodeSelect: type: boolean description: >- Ob neben dem Telefonfeld ein Ländercode-Dropdown angezeigt werden soll. validation: $ref: '#/components/schemas/PhoneFieldValidation' x-hubspot-sub-type-impl: true MobilePhoneField: title: mobile_phone required: - dependentFields - fieldType - hidden - label - name - objectTypeId - required - validation type: object properties: defaultValue: type: string description: >- Der Wert, der standardmäßig angegeben wird. Dieser Wert wird übermittelt, wenn der Kunde ihn nicht ändert. dependentFields: type: array description: >- Eine Liste sonstiger Felder, die basierend auf dem für dieses Feld eingegebenen Wert sichtbar gemacht werden sollen. items: $ref: '#/components/schemas/DependentField' description: type: string description: >- Zusätzlicher Text als Hilfestellung für den Kunden zum Ausfüllen des Felds. fieldType: type: string description: Legt fest, wie das Feld angezeigt und validiert werden soll. default: mobile_phone enum: - mobile_phone hidden: type: boolean description: >- Ob ein Feld ausgeblendet werden soll oder nicht. Ausgeblendete Felder werden nicht im Formular angezeigt, können jedoch verwendet werden, um einen Wert an eine Eigenschaft zu übergeben, ohne dass der Kunde etwas ausfüllen muss. label: type: string description: Das Haupt-Label für das Formularfeld. name: type: string description: >- Die ID des Feldes. In Kombination mit der Objekttyp-ID muss diese eindeutig sein. objectTypeId: type: string description: >- Eine eindeutige ID für den CRM-Objekttyp dieses Feldes. Ein KONTAKT-Feld hat zum Beispiel die Objekttyp-ID 0-1. placeholder: type: string description: Der angezeigte Prompt-Text, sofern das Feld nicht ausgefüllt ist. required: type: boolean description: >- Ob ein Wert für dieses Feld beim Absenden des Formulars erforderlich ist. validation: $ref: '#/components/schemas/PhoneFieldValidation' x-hubspot-sub-type-impl: true SingleLineTextField: title: single_line_text required: - dependentFields - fieldType - hidden - label - name - objectTypeId - required type: object properties: defaultValue: type: string description: >- Der Wert, der standardmäßig angegeben wird. Dieser Wert wird übermittelt, wenn der Kunde ihn nicht ändert. dependentFields: type: array description: >- Eine Liste sonstiger Felder, die basierend auf dem für dieses Feld eingegebenen Wert sichtbar gemacht werden sollen. items: $ref: '#/components/schemas/DependentField' description: type: string description: >- Zusätzlicher Text als Hilfestellung für den Kunden zum Ausfüllen des Felds. fieldType: type: string description: Legt fest, wie das Feld angezeigt und validiert werden soll. default: single_line_text enum: - single_line_text hidden: type: boolean description: >- Ob ein Feld ausgeblendet werden soll oder nicht. Ausgeblendete Felder werden nicht im Formular angezeigt, können jedoch verwendet werden, um einen Wert an eine Eigenschaft zu übergeben, ohne dass der Kunde etwas ausfüllen muss. label: type: string description: Das Haupt-Label für das Formularfeld. name: type: string description: >- Die ID des Feldes. In Kombination mit der Objekttyp-ID muss diese eindeutig sein. objectTypeId: type: string description: >- Eine eindeutige ID für den CRM-Objekttyp dieses Feldes. Ein KONTAKT-Feld hat zum Beispiel die Objekttyp-ID 0-1. placeholder: type: string description: Der angezeigte Prompt-Text, sofern das Feld nicht ausgefüllt ist. required: type: boolean description: >- Ob ein Wert für dieses Feld beim Absenden des Formulars erforderlich ist. x-hubspot-sub-type-impl: true MultiLineTextField: title: multi_line_text required: - dependentFields - fieldType - hidden - label - name - objectTypeId - required type: object properties: defaultValue: type: string description: >- Der Wert, der standardmäßig angegeben wird. Dieser Wert wird übermittelt, wenn der Kunde ihn nicht ändert. dependentFields: type: array description: >- Eine Liste sonstiger Felder, die basierend auf dem für dieses Feld eingegebenen Wert sichtbar gemacht werden sollen. items: $ref: '#/components/schemas/DependentField' description: type: string description: >- Zusätzlicher Text als Hilfestellung für den Kunden zum Ausfüllen des Felds. fieldType: type: string description: Legt fest, wie das Feld angezeigt und validiert werden soll. default: multi_line_text enum: - multi_line_text hidden: type: boolean description: >- Ob ein Feld ausgeblendet werden soll oder nicht. Ausgeblendete Felder werden nicht im Formular angezeigt, können jedoch verwendet werden, um einen Wert an eine Eigenschaft zu übergeben, ohne dass der Kunde etwas ausfüllen muss. label: type: string description: Das Haupt-Label für das Formularfeld. name: type: string description: >- Die ID des Feldes. In Kombination mit der Objekttyp-ID muss diese eindeutig sein. objectTypeId: type: string description: >- Eine eindeutige ID für den CRM-Objekttyp dieses Feldes. Ein KONTAKT-Feld hat zum Beispiel die Objekttyp-ID 0-1. placeholder: type: string description: Der angezeigte Prompt-Text, sofern das Feld nicht ausgefüllt ist. required: type: boolean description: >- Ob ein Wert für dieses Feld beim Absenden des Formulars erforderlich ist. x-hubspot-sub-type-impl: true NumberField: title: number required: - dependentFields - fieldType - hidden - label - name - objectTypeId - required type: object properties: defaultValue: type: string description: >- Der Wert, der standardmäßig angegeben wird. Dieser Wert wird übermittelt, wenn der Kunde ihn nicht ändert. dependentFields: type: array description: >- Eine Liste sonstiger Felder, die basierend auf dem für dieses Feld eingegebenen Wert sichtbar gemacht werden sollen. items: $ref: '#/components/schemas/DependentField' description: type: string description: >- Zusätzlicher Text als Hilfestellung für den Kunden zum Ausfüllen des Felds. fieldType: type: string description: Legt fest, wie das Feld angezeigt und validiert werden soll. default: number enum: - number hidden: type: boolean description: >- Ob ein Feld ausgeblendet werden soll oder nicht. Ausgeblendete Felder werden nicht im Formular angezeigt, können jedoch verwendet werden, um einen Wert an eine Eigenschaft zu übergeben, ohne dass der Kunde etwas ausfüllen muss. label: type: string description: Das Haupt-Label für das Formularfeld. name: type: string description: >- Die ID des Feldes. In Kombination mit der Objekttyp-ID muss diese eindeutig sein. objectTypeId: type: string description: >- Eine eindeutige ID für den CRM-Objekttyp dieses Feldes. Ein KONTAKT-Feld hat zum Beispiel die Objekttyp-ID 0-1. placeholder: type: string description: Der angezeigte Prompt-Text, sofern das Feld nicht ausgefüllt ist. required: type: boolean description: >- Ob ein Wert für dieses Feld beim Absenden des Formulars erforderlich ist. validation: $ref: '#/components/schemas/NumberFieldValidation' x-hubspot-sub-type-impl: true SingleCheckboxField: title: single_checkbox required: - dependentFields - fieldType - hidden - label - name - objectTypeId - required type: object properties: defaultValue: type: string description: >- Der Wert, der standardmäßig angegeben wird. Dieser Wert wird übermittelt, wenn der Kunde ihn nicht ändert. dependentFields: type: array description: >- Eine Liste sonstiger Felder, die basierend auf dem für dieses Feld eingegebenen Wert sichtbar gemacht werden sollen. items: $ref: '#/components/schemas/DependentField' description: type: string description: >- Zusätzlicher Text als Hilfestellung für den Kunden zum Ausfüllen des Felds. fieldType: type: string description: Legt fest, wie das Feld angezeigt und validiert werden soll. default: single_checkbox enum: - single_checkbox hidden: type: boolean description: >- Ob ein Feld ausgeblendet werden soll oder nicht. Ausgeblendete Felder werden nicht im Formular angezeigt, können jedoch verwendet werden, um einen Wert an eine Eigenschaft zu übergeben, ohne dass der Kunde etwas ausfüllen muss. label: type: string description: Das Haupt-Label für das Formularfeld. name: type: string description: >- Die ID des Feldes. In Kombination mit der Objekttyp-ID muss diese eindeutig sein. objectTypeId: type: string description: >- Eine eindeutige ID für den CRM-Objekttyp dieses Feldes. Ein KONTAKT-Feld hat zum Beispiel die Objekttyp-ID 0-1. required: type: boolean description: >- Ob ein Wert für dieses Feld beim Absenden des Formulars erforderlich ist. x-hubspot-sub-type-impl: true MultipleCheckboxesField: title: multiple_checkboxes required: - defaultValues - dependentFields - fieldType - hidden - label - name - objectTypeId - options - required type: object properties: defaultValues: type: array description: >- Die Werte, die standardmäßig ausgewählt sind. Diese Werte werden übermittelt, wenn der Kunde sie nicht ändert. items: type: string dependentFields: type: array description: >- Eine Liste sonstiger Felder, die basierend auf dem für dieses Feld eingegebenen Wert sichtbar gemacht werden sollen. items: $ref: '#/components/schemas/DependentField' description: type: string description: >- Zusätzlicher Text als Hilfestellung für den Kunden zum Ausfüllen des Felds. fieldType: type: string description: Legt fest, wie das Feld angezeigt und validiert werden soll. default: multiple_checkboxes enum: - multiple_checkboxes hidden: type: boolean description: >- Ob ein Feld ausgeblendet werden soll oder nicht. Ausgeblendete Felder werden nicht im Formular angezeigt, können jedoch verwendet werden, um einen Wert an eine Eigenschaft zu übergeben, ohne dass der Kunde etwas ausfüllen muss. label: type: string description: Das Haupt-Label für das Formularfeld. name: type: string description: >- Die ID des Feldes. In Kombination mit der Objekttyp-ID muss diese eindeutig sein. objectTypeId: type: string description: >- Eine eindeutige ID für den CRM-Objekttyp dieses Feldes. Ein KONTAKT-Feld hat zum Beispiel die Objekttyp-ID 0-1. options: type: array description: Die Liste der verfügbaren Auswahlmöglichkeiten für dieses Feld. items: $ref: '#/components/schemas/EnumeratedFieldOption' required: type: boolean description: >- Ob ein Wert für dieses Feld beim Absenden des Formulars erforderlich ist. x-hubspot-sub-type-impl: true DropdownField: title: dropdown required: - defaultValues - dependentFields - fieldType - hidden - label - name - objectTypeId - options - required type: object properties: defaultValues: type: array description: >- Die Werte, die standardmäßig ausgewählt sind. Diese Werte werden übermittelt, wenn der Kunde sie nicht ändert. items: type: string dependentFields: type: array description: >- Eine Liste sonstiger Felder, die basierend auf dem für dieses Feld eingegebenen Wert sichtbar gemacht werden sollen. items: $ref: '#/components/schemas/DependentField' description: type: string description: >- Zusätzlicher Text als Hilfestellung für den Kunden zum Ausfüllen des Felds. fieldType: type: string description: Legt fest, wie das Feld angezeigt und validiert werden soll. default: dropdown enum: - dropdown hidden: type: boolean description: >- Ob ein Feld ausgeblendet werden soll oder nicht. Ausgeblendete Felder werden nicht im Formular angezeigt, können jedoch verwendet werden, um einen Wert an eine Eigenschaft zu übergeben, ohne dass der Kunde etwas ausfüllen muss. label: type: string description: Das Haupt-Label für das Formularfeld. name: type: string description: >- Die ID des Feldes. In Kombination mit der Objekttyp-ID muss diese eindeutig sein. objectTypeId: type: string description: >- Eine eindeutige ID für den CRM-Objekttyp dieses Feldes. Ein KONTAKT-Feld hat zum Beispiel die Objekttyp-ID 0-1. options: type: array description: Die Liste der verfügbaren Auswahlmöglichkeiten für dieses Feld. items: $ref: '#/components/schemas/EnumeratedFieldOption' placeholder: type: string description: Der angezeigte Prompt-Text, sofern das Feld nicht ausgefüllt ist. required: type: boolean description: >- Ob ein Wert für dieses Feld beim Absenden des Formulars erforderlich ist. x-hubspot-sub-type-impl: true RadioField: title: radio required: - defaultValues - dependentFields - fieldType - hidden - label - name - objectTypeId - options - required type: object properties: defaultValues: type: array description: >- Die Werte, die standardmäßig ausgewählt sind. Diese Werte werden übermittelt, wenn der Kunde sie nicht ändert. items: type: string dependentFields: type: array description: >- Eine Liste sonstiger Felder, die basierend auf dem für dieses Feld eingegebenen Wert sichtbar gemacht werden sollen. items: $ref: '#/components/schemas/DependentField' description: type: string description: >- Zusätzlicher Text als Hilfestellung für den Kunden zum Ausfüllen des Felds. fieldType: type: string description: Legt fest, wie das Feld angezeigt und validiert werden soll. default: radio enum: - radio hidden: type: boolean description: >- Ob ein Feld ausgeblendet werden soll oder nicht. Ausgeblendete Felder werden nicht im Formular angezeigt, können jedoch verwendet werden, um einen Wert an eine Eigenschaft zu übergeben, ohne dass der Kunde etwas ausfüllen muss. label: type: string description: Das Haupt-Label für das Formularfeld. name: type: string description: >- Die ID des Feldes. In Kombination mit der Objekttyp-ID muss diese eindeutig sein. objectTypeId: type: string description: >- Eine eindeutige ID für den CRM-Objekttyp dieses Feldes. Ein KONTAKT-Feld hat zum Beispiel die Objekttyp-ID 0-1. options: type: array description: Die Liste der verfügbaren Auswahlmöglichkeiten für dieses Feld. items: $ref: '#/components/schemas/EnumeratedFieldOption' placeholder: type: string description: Der angezeigte Prompt-Text, sofern das Feld nicht ausgefüllt ist. required: type: boolean description: >- Ob ein Wert für dieses Feld beim Absenden des Formulars erforderlich ist. x-hubspot-sub-type-impl: true DatepickerField: title: datepicker required: - dependentFields - fieldType - hidden - label - name - objectTypeId - required type: object properties: defaultValue: type: string description: >- Der Wert, der standardmäßig angegeben wird. Dieser Wert wird übermittelt, wenn der Kunde ihn nicht ändert. dependentFields: type: array description: >- Eine Liste sonstiger Felder, die basierend auf dem für dieses Feld eingegebenen Wert sichtbar gemacht werden sollen. items: $ref: '#/components/schemas/DependentField' description: type: string description: >- Zusätzlicher Text als Hilfestellung für den Kunden zum Ausfüllen des Felds. fieldType: type: string description: Legt fest, wie das Feld angezeigt und validiert werden soll. default: datepicker enum: - datepicker hidden: type: boolean description: >- Ob ein Feld ausgeblendet werden soll oder nicht. Ausgeblendete Felder werden nicht im Formular angezeigt, können jedoch verwendet werden, um einen Wert an eine Eigenschaft zu übergeben, ohne dass der Kunde etwas ausfüllen muss. label: type: string description: Das Haupt-Label für das Formularfeld. name: type: string description: >- Die ID des Feldes. In Kombination mit der Objekttyp-ID muss diese eindeutig sein. objectTypeId: type: string description: >- Eine eindeutige ID für den CRM-Objekttyp dieses Feldes. Ein KONTAKT-Feld hat zum Beispiel die Objekttyp-ID 0-1. placeholder: type: string description: Der angezeigte Prompt-Text, sofern das Feld nicht ausgefüllt ist. required: type: boolean description: >- Ob ein Wert für dieses Feld beim Absenden des Formulars erforderlich ist. x-hubspot-sub-type-impl: true FileField: title: file required: - allowMultipleFiles - dependentFields - fieldType - hidden - label - name - objectTypeId - required type: object properties: allowMultipleFiles: type: boolean description: Ob der Upload mehrerer Dateien zulässig sein soll. defaultValue: type: string description: >- Der Wert, der standardmäßig angegeben wird. Dieser Wert wird übermittelt, wenn der Kunde ihn nicht ändert. dependentFields: type: array description: >- Eine Liste sonstiger Felder, die basierend auf dem für dieses Feld eingegebenen Wert sichtbar gemacht werden sollen. items: $ref: '#/components/schemas/DependentField' description: type: string description: >- Zusätzlicher Text als Hilfestellung für den Kunden zum Ausfüllen des Felds. fieldType: type: string description: Legt fest, wie das Feld angezeigt und validiert werden soll. default: file enum: - file hidden: type: boolean description: >- Ob ein Feld ausgeblendet werden soll oder nicht. Ausgeblendete Felder werden nicht im Formular angezeigt, können jedoch verwendet werden, um einen Wert an eine Eigenschaft zu übergeben, ohne dass der Kunde etwas ausfüllen muss. label: type: string description: Das Haupt-Label für das Formularfeld. name: type: string description: >- Die ID des Feldes. In Kombination mit der Objekttyp-ID muss diese eindeutig sein. objectTypeId: type: string description: >- Eine eindeutige ID für den CRM-Objekttyp dieses Feldes. Ein KONTAKT-Feld hat zum Beispiel die Objekttyp-ID 0-1. placeholder: type: string description: Der angezeigte Prompt-Text, sofern das Feld nicht ausgefüllt ist. required: type: boolean description: >- Ob ein Wert für dieses Feld beim Absenden des Formulars erforderlich ist. x-hubspot-sub-type-impl: true PaymentLinkRadioField: title: payment_link_radio required: - defaultValues - dependentFields - fieldType - hidden - label - name - objectTypeId - options - required type: object properties: defaultValues: type: array items: type: string dependentFields: type: array items: $ref: '#/components/schemas/DependentField' description: type: string description: Zusätzlicher beschreibender Text zum Feld. fieldType: type: string description: Die Feldtyp-ID. default: payment_link_radio enum: - payment_link_radio hidden: type: boolean description: Ob es sich bei dem Feld um ein ausgeblendetes Feld handelt. label: type: string description: >- Das sichtbare Label, das zusammen mit dem Feld angezeigt wird, um den Benutzern dessen Zweck zu beschreiben. name: type: string description: >- Der interne API-Name, der zur Identifizierung dieses Feldes in API-Anfragen und -Antworten verwendet wird. objectTypeId: type: string description: "Der CRM-Objekttyp, dem dieses Feld zugeordnet ist (z.\_B. Kontakte, Deals)." options: type: array items: $ref: '#/components/schemas/EnumeratedFieldOption' required: type: boolean description: >- Ob Benutzer vor dem Absenden des Formulars eine Option auswählen müssen. x-hubspot-sub-type-impl: true LegalConsentCheckbox: required: - label - required - subscriptionTypeId type: object properties: label: type: string description: Das Haupt-Label für das Formularfeld. required: type: boolean description: >- Ob dieses Kontrollkästchen beim Absenden des Formulars erforderlich ist. subscriptionTypeId: type: integer description: >- Die ID des Abonnementtyps, der diesem Kontrollkästchen für Einwilligung zugeordnet ist. format: int64 ErrorDetail: required: - message type: object properties: code: type: string description: Der Statuscode, der dem Fehlerdetail zugeordnet ist context: type: object additionalProperties: type: array items: type: string description: Kontext zur Fehlerbedingung example: '{missingScopes=[scope1, scope2]}' in: type: string description: >- Der Name des Felds oder Parameters, in dem der Fehler gefunden wurde. message: type: string description: >- Eine für Menschen lesbare Nachricht mit einer Beschreibung des Fehlers und ggf. Abhilfemaßnahmen subCategory: type: string description: Eine spezifische Kategorie, die genauere Details zum Fehler enthält DependentField: required: - dependentCondition - dependentField type: object properties: dependentCondition: $ref: '#/components/schemas/DependentFieldFilter' dependentField: description: >- Ein Formularfeld, das abhängig davon angezeigt wird, ob die abhängige Bedingung erfüllt ist. oneOf: - $ref: '#/components/schemas/EmailField' - $ref: '#/components/schemas/PhoneField' - $ref: '#/components/schemas/MobilePhoneField' - $ref: '#/components/schemas/SingleLineTextField' - $ref: '#/components/schemas/MultiLineTextField' - $ref: '#/components/schemas/NumberField' - $ref: '#/components/schemas/SingleCheckboxField' - $ref: '#/components/schemas/MultipleCheckboxesField' - $ref: '#/components/schemas/DropdownField' - $ref: '#/components/schemas/RadioField' - $ref: '#/components/schemas/DatepickerField' - $ref: '#/components/schemas/FileField' - $ref: '#/components/schemas/PaymentLinkRadioField' EmailFieldValidation: required: - blockedEmailDomains - useDefaultBlockList type: object properties: blockedEmailDomains: type: array description: Eine Liste der zu blockierenden E-Mail-Domains. items: type: string useDefaultBlockList: type: boolean description: Ob kostenlose E-Mail-Anbieter blockiert werden oder nicht. PhoneFieldValidation: required: - maxAllowedDigits - minAllowedDigits type: object properties: maxAllowedDigits: type: integer description: >- Die maximale Anzahl der Ziffern für eine Telefonnummer. Standard: 20. Muss größer oder gleich minAllowedDigits sein. format: int32 minAllowedDigits: type: integer description: >- Die minimale Anzahl der Ziffern für eine Telefonnummer. Standard: 7. Muss kleiner oder gleich maxAllowedDigits sein. format: int32 NumberFieldValidation: required: - maxAllowedDigits - minAllowedDigits type: object properties: maxAllowedDigits: type: integer description: >- Die maximale Anzahl der Ziffern für die Eingabe in das Zahlenfeld. Muss größer oder gleich minAllowedDigits sein. format: int32 minAllowedDigits: type: integer description: >- Die minimale Anzahl der Ziffern für eine gültige Eingabe in das Zahlenfeld. Muss kleiner oder gleich maxAllowedDigits sein. format: int32 EnumeratedFieldOption: required: - displayOrder - label - value type: object properties: description: type: string description: Zusätzlicher beschreibender Text zur Option. displayOrder: type: integer description: Die Reihenfolge, in der die Optionen angezeigt wird. format: int32 label: type: string description: Das sichtbare Label für diese Option. value: type: string description: Der übermittelte Wert, wenn diese Option ausgewählt wird. DependentFieldFilter: required: - operator - rangeEnd - rangeStart - value - values type: object properties: operator: type: string description: >- Der Vergleichsoperator für die Auswertung der Bedingung des abhängigen Feldes. Unterstützt Gleichheit (eq, neq), Zeichenfolgenvorgänge (contains, doesnt_contain, str_starts_with, str_ends_with), numerische Vergleiche (lt, lte, gt, gte), Bereichsüberprüfungen (between, not_between), festgelegte Vorgänge (set_any, set_not_any, set_eq, set_neq) und zeitbasierte Bedingungen (within_time, within_time_reverse). enum: - 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 rangeEnd: type: string description: >- Der Endwert für zeitraumbasierte Operatoren (between, not_between). Darf nicht zusammen mit „rangeStart“ bereitgestellt werden. rangeStart: type: string description: >- Der Startwert für zeitraumbasierte Operatoren (between, not_between). Darf nicht zusammen mit „rangeEnd“ bereitgestellt werden. value: type: string description: >- Der Einzelwert für den Vergleich beim Einsatz von Operatoren wie eq, neq, contains, lt, gt und anderen Einzelwert-Vergleichsoperatoren. values: type: array items: type: string responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://app.hubspot.com/oauth/authorize tokenUrl: https://api.hubapi.com/oauth/v1/token scopes: forms: '' ````