> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.jp/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a form definition

> 指定されたフォームIDを使用して、HubSpotアカウントの既存のフォームを更新します。このエンドポイントでは、フォームの設定、表示オプション、法的同意オプションなどのプロパティーを変更できます。フォームIDが有効であり、フォームを更新するために必要な権限があることを確認してください。

export const ScopesList = ({scopes = [], description = "この API には、次のいずれかのスコープが必要です。"}) => {
  if (!scopes || scopes.length === 0) {
    return null;
  }
  const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
  return <div>
      <div className="text-sm mb-2">{description}</div>
      <div>
        {sortedScopes.map((scope, index) => <div key={index}>
            <code>
              <span className="text-xs">{scope}</span>
            </code>
          </div>)}
      </div>
    </div>;
};

export const SupportedProducts = ({marketing, sales, service, cms, marketingLevel, salesLevel, serviceLevel, cmsLevel}) => {
  const translations = {
    header: "サポートされる製品",
    description: "次のいずれかの製品またはそれ以上が必要です。",
    productNames: {
      marketing: "Marketing Hub",
      sales: "Sales Hub",
      service: "Service Hub",
      cms: "Content Hub"
    },
    tiers: {
      free: "無料ツール",
      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 <div>
      <div className="text-sm mb-2">{translations.description}</div>
      <div className={`grid ${products.length === 1 ? 'grid-cols-1' : 'grid-cols-2'} gap-1.5`}>
        {products.map((product, index) => <div key={index} style={{
    display: 'flex',
    alignItems: 'center'
  }}>
            <img src={product.icon} alt={product.alt} className="w-3.5 h-3.5 mr-1.5 mt-2.5 mb-2.5 flex-shrink-0 align-middle" />
            <span className="font-medium mr-1 text-sm">{product.name} -</span>
            <span className="text-sm">{product.level}</span>
          </div>)}
      </div>
    </div>;
};

<AccordionGroup>
  <Accordion title="Supported products" defaultOpen="true" icon="cubes">
    <SupportedProducts marketing={true} sales={true} service={true} cms={true} marketingLevel="FREE" salesLevel="FREE" serviceLevel="FREE" cmsLevel="FREE" />
  </Accordion>

  <Accordion title="Required Scopes" icon="key">
    <ScopesList
      scopes={[
  'forms'
]}
    />
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml specs/2026-09-beta/marketing-forms-v2026-09-beta.json PUT /marketing/forms/2026-09-beta/{formId}
openapi: 3.0.1
info:
  title: フォーム
  description: Basepom for all HubSpot Projects
  version: 2026-09-beta
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-api-use-case: >-
    より複雑な活用事例やサードパーティーサービスからのデータに基づいて、プログラムを使用してHubSpotフォームの特定の部分を変更します（外部ソースから照会しているデータに基づいてフィールドが動的に表示されます）。
  x-hubspot-introduction: >-
    フォームAPIを使用して、HubSpotアカウントでフォームの作成や管理を行います。このフォームはその後、ウェブサイトに埋め込んでウェブサイト訪問者からのフォーム送信を収集できます。
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
paths:
  /marketing/forms/2026-09-beta/{formId}:
    put:
      tags:
        - Basic
      summary: フォーム定義を更新
      description: >-
        指定されたフォームIDを使用して、HubSpotアカウントの既存のフォームを更新します。このエンドポイントでは、フォームの設定、表示オプション、法的同意オプションなどのプロパティーを変更できます。フォームIDが有効であり、フォームを更新するために必要な権限があることを確認してください。
      operationId: >-
        put-/marketing/forms/2026-09-beta/{formId}_/marketing/forms/2026-09-beta/{formId}
      parameters:
        - name: formId
          in: path
          description: フォームの固有ID。
          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: フォームにリセットリンクを追加するかどうか。これにより、フォームに入力されている内容が削除され、送信時に新しいコンタクトが作成されます。
        archivable:
          type: boolean
          description: フォームをアーカイブできるかどうか。
        cloneable:
          type: boolean
          description: フォームを複製できるかどうか。
        createNewContactForNewEmail:
          type: boolean
          description: フォームが既存のコンタクトレコードに一致しないEメールアドレスで送信された場合に、新しいコンタクトを作成するかどうか。
        editable:
          type: boolean
          description: フォームを編集できるかどうか。
        embedType:
          type: string
          description: フォームの埋め込みタイプを示す文字列です。有効な値は「V3」と「V4」です。
          enum:
            - V3
            - V4
        language:
          type: string
          description: フォームの言語。
          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
          description: フォームに関連付けられたライフサイクルステージの配列。各ステージは、objectTypeIdと値を含むオブジェクトで表されます。
          items:
            $ref: '#/components/schemas/LifecycleStage'
        notifyContactOwner:
          type: boolean
          description: 送信を受信したときに、コンタクト担当者に通知Eメールを送信するかどうか。
        notifyRecipients:
          type: array
          description: 送信を受信したときに通知Eメールを受け取るユーザーIDのリスト。
          items:
            type: string
        postSubmitAction:
          $ref: '#/components/schemas/FormPostSubmitAction'
        prePopulateKnownValues:
          type: boolean
          description: コンタクトによる再訪問時に、既に判明している情報でコンタクトフィールドを埋めておくかどうか。
        recaptchaEnabled:
          type: boolean
          description: CAPTCHA（スパム防止）が有効であるかどうか。
    FormDisplayOptions:
      required:
        - renderRawHtml
        - style
        - submitButtonText
        - theme
      type: object
      properties:
        cssClass:
          type: string
          description: 追加のスタイル設定用にフォーム要素に適用するカスタムCSSクラス名。
        renderRawHtml:
          type: boolean
          description: フォームをiFrame内ではなく未加工のHTMLとして表示するかどうか。
        style:
          $ref: '#/components/schemas/FormStyle'
        submitButtonText:
          type: string
          description: フォームの送信ボタンに表示されるテキスト。
        theme:
          type: string
          description: 入力フィールドのスタイル設定に使用するテーマ。フォームがHubSpot CMSページに追加されている場合は適用されません。
          enum:
            - canvas
            - default_style
            - legacy
            - linear
            - round
            - sharp
    FieldGroup:
      required:
        - fields
        - groupType
        - richTextType
      type: object
      properties:
        fields:
          type: array
          description: グループに含まれるフォームフィールド
          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: フィールドグループ化のタイプ。値：default_group（標準フィールド）、progressive、queued。
          enum:
            - default_group
            - progressive
            - queued
        richText:
          type: string
          description: >-
            リッチテキストのブロックまたは画像。フォームに入力する顧客に追加情報を提供するために使用できます。フィールドグループにフィールドが含まれている場合、リッチテキストはフィールドの前に表示されます。
        richTextType:
          type: string
          description: 含まれるリッチテキストのタイプ。デフォルト値はtextです。値：text、image。
          enum:
            - image
            - text
    LegalConsentOptionsNone:
      title: none
      required:
        - type
      type: object
      properties:
        type:
          type: string
          description: 法的同意タイプ。このフォームに法的同意設定が不要であることを示すには「none」に設定します。
          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: >-
            正当な利害関係に基づくデータ処理の法的根拠。値：lead（リードジェネレーションを目的とした処理）、client（既存のクライアントを対象とした処理）、other（その他の正当な利害関係）。デフォルト：lead。
          enum:
            - client
            - lead
            - other
        privacyText:
          type: string
          description: プライバシーポリシーとデータ処理について説明するテキスト。
        subscriptionTypeIds:
          type: array
          items:
            type: integer
            format: int64
        type:
          type: string
          description: 法的同意タイプ。
          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: コミュニケーション同意設定について説明するテキスト。コンタクト情報がコミュニケーションに使用されることをユーザーに知らせます。
        communicationsCheckboxes:
          type: array
          items:
            $ref: '#/components/schemas/LegalConsentCheckbox'
        consentToProcessCheckboxLabel:
          type: string
          description: 処理への同意チェックボックスのラベルテキスト。
        consentToProcessFooterText:
          type: string
          description: 処理への同意セクションのフッターテキスト。
        consentToProcessText:
          type: string
          description: 個人データの処理への同意について説明するテキスト。
        privacyText:
          type: string
          description: プライバシーポリシーとデータ処理について説明するテキスト。プライバシーの権利やデータの保護方法についてユーザーに知らせる必須フィールド。
        type:
          type: string
          description: 法的同意タイプ。
          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: コミュニケーション同意設定について説明するテキスト。
        communicationsCheckboxes:
          type: array
          description: コミュニケーション同意オプションのチェックボックスを表すLegalConsentCheckboxオブジェクトの配列。
          items:
            $ref: '#/components/schemas/LegalConsentCheckbox'
        consentToProcessText:
          type: string
          description: 個人データの処理への同意について説明するテキスト。
        privacyText:
          type: string
          description: プライバシーポリシーとデータ処理について説明するテキスト。
        type:
          type: string
          description: 法的同意タイプ。
          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: エラーカテゴリー
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: エラー条件に関する背景状況
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: リクエストの固有ID。エラー報告またはサポートチケットには必ずこの値を含めてください
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: エラーに関する詳細情報
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: エラーまたは推奨の修正手順に関するドキュメントが含まれる関連付けられたURIへのリンク名の対応付け
        message:
          type: string
          description: エラーと修正手順（該当する場合）を記した、人が理解できるメッセージ
          example: An error occurred
        subCategory:
          type: string
          description: エラーに関する具体的な詳細が含まれる特定のカテゴリー
      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: コンタクトと会社の両方のobjectTypeId。
        value:
          type: string
          description: フォーム送信時に設定されたコンタクトのライフサイクルステージの内部名
    FormPostSubmitAction:
      required:
        - type
        - value
      type: object
      properties:
        type:
          type: string
          description: 送信後のアクション。デフォルトのアクションはサンキューメッセージの表示です。
          enum:
            - redirect_url
            - thank_you
        value:
          type: string
          description: サンキューテキストまたはリダイレクト先のページ。
    FormStyle:
      required:
        - backgroundWidth
        - fontFamily
        - helpTextColor
        - helpTextSize
        - labelTextColor
        - labelTextSize
        - legalConsentTextColor
        - legalConsentTextSize
        - submitAlignment
        - submitColor
        - submitFontColor
        - submitSize
      type: object
      properties:
        backgroundWidth:
          type: string
          description: フォームの背景の幅。パーセント（例：「100%」）またはピクセル値（例：「600px」）を受け入れます。
        fontFamily:
          type: string
          description: フォーム全体で使用されるフォントファミリー（例：「arial, helvetica, sans-serif」）。
        helpTextColor:
          type: string
          description: フォームフィールドの下に表示されるヘルプテキストの16進カラーコード。
        helpTextSize:
          type: string
          description: ヘルプテキストのフォントサイズ。ピクセル値（例：「11px」）を受け入れます。
        labelTextColor:
          type: string
          description: フィールドラベルの16進カラーコード。
        labelTextSize:
          type: string
          description: フィールドラベルのフォントサイズ。ピクセル値（例：「11px」）を受け入れます。
        legalConsentTextColor:
          type: string
          description: 法的同意テキストの16進カラーコード。
        legalConsentTextSize:
          type: string
          description: 法的同意テキストのフォントサイズ。ピクセル値（例：「14px」）を受け入れます。
        submitAlignment:
          type: string
          description: 送信ボタンの水平方向のアラインメント（位置合わせ）。値：left、center、right。
          enum:
            - center
            - left
            - right
        submitColor:
          type: string
          description: 送信ボタンの背景の16進カラーコード。
        submitFontColor:
          type: string
          description: 送信ボタンのテキストの16進カラーコード。
        submitSize:
          type: string
          description: 送信ボタンのテキストのフォントサイズ。ピクセル値（例：「12px」）を受け入れます。
    EmailField:
      title: email
      required:
        - dependentFields
        - fieldType
        - hidden
        - label
        - name
        - objectTypeId
        - required
        - validation
      type: object
      properties:
        defaultValue:
          type: string
          description: デフォルトで入力される値。顧客が修正しない限り、この値が送信されます。
        dependentFields:
          type: array
          description: このフィールドに入力された値に基づいて表示する他のフィールドのリスト。
          items:
            $ref: '#/components/schemas/DependentField'
        description:
          type: string
          description: 顧客によるフィールドへの入力を支援する追加テキスト。
        fieldType:
          type: string
          description: フィールドの表示方法と検証方法を決定します。
          default: email
          enum:
            - email
        hidden:
          type: boolean
          description: >-
            フィールドを非表示にするかどうか。非表示のフィールドはフォームには表示されませんが、顧客の入力を必要とせずにプロパティーに値を渡すために使用できます。
        label:
          type: string
          description: フォームフィールドのメインラベル。
        name:
          type: string
          description: フィールドのID。オブジェクトタイプIDと組み合わせて固有である必要があります。
        objectTypeId:
          type: string
          description: このフィールドのCRMオブジェクトタイプの固有ID。例えば、CONTACTフィールドのオブジェクトタイプIDは0-1です。
        placeholder:
          type: string
          description: フィールドが未入力の場合に表示されるプロンプトテキスト。
        required:
          type: boolean
          description: フォーム送信時にこのフィールドの値が必須であるかどうか。
        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: デフォルトで入力される値。顧客が修正しない限り、この値が送信されます。
        dependentFields:
          type: array
          description: このフィールドに入力された値に基づいて表示する他のフィールドのリスト。
          items:
            $ref: '#/components/schemas/DependentField'
        description:
          type: string
          description: 顧客によるフィールドへの入力を支援する追加テキスト。
        fieldType:
          type: string
          description: フィールドの表示方法と検証方法を決定します。
          default: phone
          enum:
            - phone
        hidden:
          type: boolean
          description: >-
            フィールドを非表示にするかどうか。非表示のフィールドはフォームには表示されませんが、顧客の入力を必要とせずにプロパティーに値を渡すために使用できます。
        label:
          type: string
          description: フォームフィールドのメインラベル。
        name:
          type: string
          description: フィールドのID。オブジェクトタイプIDと組み合わせて固有である必要があります。
        objectTypeId:
          type: string
          description: このフィールドのCRMオブジェクトタイプの固有ID。例えば、CONTACTフィールドのオブジェクトタイプIDは0-1です。
        placeholder:
          type: string
          description: フィールドが未入力の場合に表示されるプロンプトテキスト。
        required:
          type: boolean
          description: フォーム送信時にこのフィールドの値が必須であるかどうか。
        useCountryCodeSelect:
          type: boolean
          description: 電話番号フィールドの隣に国コードのドロップダウンを表示するかどうか。
        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: デフォルトで入力される値。顧客が修正しない限り、この値が送信されます。
        dependentFields:
          type: array
          description: このフィールドに入力された値に基づいて表示する他のフィールドのリスト。
          items:
            $ref: '#/components/schemas/DependentField'
        description:
          type: string
          description: 顧客によるフィールドへの入力を支援する追加テキスト。
        fieldType:
          type: string
          description: フィールドの表示方法と検証方法を決定します。
          default: mobile_phone
          enum:
            - mobile_phone
        hidden:
          type: boolean
          description: >-
            フィールドを非表示にするかどうか。非表示のフィールドはフォームには表示されませんが、顧客の入力を必要とせずにプロパティーに値を渡すために使用できます。
        label:
          type: string
          description: フォームフィールドのメインラベル。
        name:
          type: string
          description: フィールドのID。オブジェクトタイプIDと組み合わせて固有である必要があります。
        objectTypeId:
          type: string
          description: このフィールドのCRMオブジェクトタイプの固有ID。例えば、CONTACTフィールドのオブジェクトタイプIDは0-1です。
        placeholder:
          type: string
          description: フィールドが未入力の場合に表示されるプロンプトテキスト。
        required:
          type: boolean
          description: フォーム送信時にこのフィールドの値が必須であるかどうか。
        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: デフォルトで入力される値。顧客が修正しない限り、この値が送信されます。
        dependentFields:
          type: array
          description: このフィールドに入力された値に基づいて表示する他のフィールドのリスト。
          items:
            $ref: '#/components/schemas/DependentField'
        description:
          type: string
          description: 顧客によるフィールドへの入力を支援する追加テキスト。
        fieldType:
          type: string
          description: フィールドの表示方法と検証方法を決定します。
          default: single_line_text
          enum:
            - single_line_text
        hidden:
          type: boolean
          description: >-
            フィールドを非表示にするかどうか。非表示のフィールドはフォームには表示されませんが、顧客の入力を必要とせずにプロパティーに値を渡すために使用できます。
        label:
          type: string
          description: フォームフィールドのメインラベル。
        name:
          type: string
          description: フィールドのID。オブジェクトタイプIDと組み合わせて固有である必要があります。
        objectTypeId:
          type: string
          description: このフィールドのCRMオブジェクトタイプの固有ID。例えば、CONTACTフィールドのオブジェクトタイプIDは0-1です。
        placeholder:
          type: string
          description: フィールドが未入力の場合に表示されるプロンプトテキスト。
        required:
          type: boolean
          description: フォーム送信時にこのフィールドの値が必須であるかどうか。
      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: デフォルトで入力される値。顧客が修正しない限り、この値が送信されます。
        dependentFields:
          type: array
          description: このフィールドに入力された値に基づいて表示する他のフィールドのリスト。
          items:
            $ref: '#/components/schemas/DependentField'
        description:
          type: string
          description: 顧客によるフィールドへの入力を支援する追加テキスト。
        fieldType:
          type: string
          description: フィールドの表示方法と検証方法を決定します。
          default: multi_line_text
          enum:
            - multi_line_text
        hidden:
          type: boolean
          description: >-
            フィールドを非表示にするかどうか。非表示のフィールドはフォームには表示されませんが、顧客の入力を必要とせずにプロパティーに値を渡すために使用できます。
        label:
          type: string
          description: フォームフィールドのメインラベル。
        name:
          type: string
          description: フィールドのID。オブジェクトタイプIDと組み合わせて固有である必要があります。
        objectTypeId:
          type: string
          description: このフィールドのCRMオブジェクトタイプの固有ID。例えば、CONTACTフィールドのオブジェクトタイプIDは0-1です。
        placeholder:
          type: string
          description: フィールドが未入力の場合に表示されるプロンプトテキスト。
        required:
          type: boolean
          description: フォーム送信時にこのフィールドの値が必須であるかどうか。
      x-hubspot-sub-type-impl: true
    NumberField:
      title: number
      required:
        - dependentFields
        - fieldType
        - hidden
        - label
        - name
        - objectTypeId
        - required
      type: object
      properties:
        defaultValue:
          type: string
          description: デフォルトで入力される値。顧客が修正しない限り、この値が送信されます。
        dependentFields:
          type: array
          description: このフィールドに入力された値に基づいて表示する他のフィールドのリスト。
          items:
            $ref: '#/components/schemas/DependentField'
        description:
          type: string
          description: 顧客によるフィールドへの入力を支援する追加テキスト。
        fieldType:
          type: string
          description: フィールドの表示方法と検証方法を決定します。
          default: number
          enum:
            - number
        hidden:
          type: boolean
          description: >-
            フィールドを非表示にするかどうか。非表示のフィールドはフォームには表示されませんが、顧客の入力を必要とせずにプロパティーに値を渡すために使用できます。
        label:
          type: string
          description: フォームフィールドのメインラベル。
        name:
          type: string
          description: フィールドのID。オブジェクトタイプIDと組み合わせて固有である必要があります。
        objectTypeId:
          type: string
          description: このフィールドのCRMオブジェクトタイプの固有ID。例えば、CONTACTフィールドのオブジェクトタイプIDは0-1です。
        placeholder:
          type: string
          description: フィールドが未入力の場合に表示されるプロンプトテキスト。
        required:
          type: boolean
          description: フォーム送信時にこのフィールドの値が必須であるかどうか。
        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: デフォルトで入力される値。顧客が修正しない限り、この値が送信されます。
        dependentFields:
          type: array
          description: このフィールドに入力された値に基づいて表示する他のフィールドのリスト。
          items:
            $ref: '#/components/schemas/DependentField'
        description:
          type: string
          description: 顧客によるフィールドへの入力を支援する追加テキスト。
        fieldType:
          type: string
          description: フィールドの表示方法と検証方法を決定します。
          default: single_checkbox
          enum:
            - single_checkbox
        hidden:
          type: boolean
          description: >-
            フィールドを非表示にするかどうか。非表示のフィールドはフォームには表示されませんが、顧客の入力を必要とせずにプロパティーに値を渡すために使用できます。
        label:
          type: string
          description: フォームフィールドのメインラベル。
        name:
          type: string
          description: フィールドのID。オブジェクトタイプIDと組み合わせて固有である必要があります。
        objectTypeId:
          type: string
          description: このフィールドのCRMオブジェクトタイプの固有ID。例えば、CONTACTフィールドのオブジェクトタイプIDは0-1です。
        required:
          type: boolean
          description: フォーム送信時にこのフィールドの値が必須であるかどうか。
      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: デフォルトで選択される値。顧客が修正しない限り、これらの値が送信されます。
          items:
            type: string
        dependentFields:
          type: array
          description: このフィールドに入力された値に基づいて表示する他のフィールドのリスト。
          items:
            $ref: '#/components/schemas/DependentField'
        description:
          type: string
          description: 顧客によるフィールドへの入力を支援する追加テキスト。
        fieldType:
          type: string
          description: フィールドの表示方法と検証方法を決定します。
          default: multiple_checkboxes
          enum:
            - multiple_checkboxes
        hidden:
          type: boolean
          description: >-
            フィールドを非表示にするかどうか。非表示のフィールドはフォームには表示されませんが、顧客の入力を必要とせずにプロパティーに値を渡すために使用できます。
        label:
          type: string
          description: フォームフィールドのメインラベル。
        name:
          type: string
          description: フィールドのID。オブジェクトタイプIDと組み合わせて固有である必要があります。
        objectTypeId:
          type: string
          description: このフィールドのCRMオブジェクトタイプの固有ID。例えば、CONTACTフィールドのオブジェクトタイプIDは0-1です。
        options:
          type: array
          description: このフィールドで使用できる選択肢のリスト。
          items:
            $ref: '#/components/schemas/EnumeratedFieldOption'
        required:
          type: boolean
          description: フォーム送信時にこのフィールドの値が必須であるかどうか。
      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: デフォルトで選択される値。顧客が修正しない限り、これらの値が送信されます。
          items:
            type: string
        dependentFields:
          type: array
          description: このフィールドに入力された値に基づいて表示する他のフィールドのリスト。
          items:
            $ref: '#/components/schemas/DependentField'
        description:
          type: string
          description: 顧客によるフィールドへの入力を支援する追加テキスト。
        fieldType:
          type: string
          description: フィールドの表示方法と検証方法を決定します。
          default: dropdown
          enum:
            - dropdown
        hidden:
          type: boolean
          description: >-
            フィールドを非表示にするかどうか。非表示のフィールドはフォームには表示されませんが、顧客の入力を必要とせずにプロパティーに値を渡すために使用できます。
        label:
          type: string
          description: フォームフィールドのメインラベル。
        name:
          type: string
          description: フィールドのID。オブジェクトタイプIDと組み合わせて固有である必要があります。
        objectTypeId:
          type: string
          description: このフィールドのCRMオブジェクトタイプの固有ID。例えば、CONTACTフィールドのオブジェクトタイプIDは0-1です。
        options:
          type: array
          description: このフィールドで使用できる選択肢のリスト。
          items:
            $ref: '#/components/schemas/EnumeratedFieldOption'
        placeholder:
          type: string
          description: フィールドが未入力の場合に表示されるプロンプトテキスト。
        required:
          type: boolean
          description: フォーム送信時にこのフィールドの値が必須であるかどうか。
      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: デフォルトで選択される値。顧客が修正しない限り、これらの値が送信されます。
          items:
            type: string
        dependentFields:
          type: array
          description: このフィールドに入力された値に基づいて表示する他のフィールドのリスト。
          items:
            $ref: '#/components/schemas/DependentField'
        description:
          type: string
          description: 顧客によるフィールドへの入力を支援する追加テキスト。
        fieldType:
          type: string
          description: フィールドの表示方法と検証方法を決定します。
          default: radio
          enum:
            - radio
        hidden:
          type: boolean
          description: >-
            フィールドを非表示にするかどうか。非表示のフィールドはフォームには表示されませんが、顧客の入力を必要とせずにプロパティーに値を渡すために使用できます。
        label:
          type: string
          description: フォームフィールドのメインラベル。
        name:
          type: string
          description: フィールドのID。オブジェクトタイプIDと組み合わせて固有である必要があります。
        objectTypeId:
          type: string
          description: このフィールドのCRMオブジェクトタイプの固有ID。例えば、CONTACTフィールドのオブジェクトタイプIDは0-1です。
        options:
          type: array
          description: このフィールドで使用できる選択肢のリスト。
          items:
            $ref: '#/components/schemas/EnumeratedFieldOption'
        placeholder:
          type: string
          description: フィールドが未入力の場合に表示されるプロンプトテキスト。
        required:
          type: boolean
          description: フォーム送信時にこのフィールドの値が必須であるかどうか。
      x-hubspot-sub-type-impl: true
    DatepickerField:
      title: datepicker
      required:
        - dependentFields
        - fieldType
        - hidden
        - label
        - name
        - objectTypeId
        - required
      type: object
      properties:
        defaultValue:
          type: string
          description: デフォルトで入力される値。顧客が修正しない限り、この値が送信されます。
        dependentFields:
          type: array
          description: このフィールドに入力された値に基づいて表示する他のフィールドのリスト。
          items:
            $ref: '#/components/schemas/DependentField'
        description:
          type: string
          description: 顧客によるフィールドへの入力を支援する追加テキスト。
        fieldType:
          type: string
          description: フィールドの表示方法と検証方法を決定します。
          default: datepicker
          enum:
            - datepicker
        hidden:
          type: boolean
          description: >-
            フィールドを非表示にするかどうか。非表示のフィールドはフォームには表示されませんが、顧客の入力を必要とせずにプロパティーに値を渡すために使用できます。
        label:
          type: string
          description: フォームフィールドのメインラベル。
        name:
          type: string
          description: フィールドのID。オブジェクトタイプIDと組み合わせて固有である必要があります。
        objectTypeId:
          type: string
          description: このフィールドのCRMオブジェクトタイプの固有ID。例えば、CONTACTフィールドのオブジェクトタイプIDは0-1です。
        placeholder:
          type: string
          description: フィールドが未入力の場合に表示されるプロンプトテキスト。
        required:
          type: boolean
          description: フォーム送信時にこのフィールドの値が必須であるかどうか。
      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: 複数ファイルのアップロードを許可するかどうか。
        defaultValue:
          type: string
          description: デフォルトで入力される値。顧客が修正しない限り、この値が送信されます。
        dependentFields:
          type: array
          description: このフィールドに入力された値に基づいて表示する他のフィールドのリスト。
          items:
            $ref: '#/components/schemas/DependentField'
        description:
          type: string
          description: 顧客によるフィールドへの入力を支援する追加テキスト。
        fieldType:
          type: string
          description: フィールドの表示方法と検証方法を決定します。
          default: file
          enum:
            - file
        hidden:
          type: boolean
          description: >-
            フィールドを非表示にするかどうか。非表示のフィールドはフォームには表示されませんが、顧客の入力を必要とせずにプロパティーに値を渡すために使用できます。
        label:
          type: string
          description: フォームフィールドのメインラベル。
        name:
          type: string
          description: フィールドのID。オブジェクトタイプIDと組み合わせて固有である必要があります。
        objectTypeId:
          type: string
          description: このフィールドのCRMオブジェクトタイプの固有ID。例えば、CONTACTフィールドのオブジェクトタイプIDは0-1です。
        placeholder:
          type: string
          description: フィールドが未入力の場合に表示されるプロンプトテキスト。
        required:
          type: boolean
          description: フォーム送信時にこのフィールドの値が必須であるかどうか。
      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: フィールドに関する追加の説明テキスト。
        fieldType:
          type: string
          description: フィールドタイプID。
          default: payment_link_radio
          enum:
            - payment_link_radio
        hidden:
          type: boolean
          description: フィールドが非表示フィールドかどうか。
        label:
          type: string
          description: フォームユーザーにその目的を説明するフィールドと一緒に表示される表示ラベル。
        name:
          type: string
          description: APIリクエストおよびレスポンスの中でこのフィールドを特定するために使用される内部API名。
        objectTypeId:
          type: string
          description: このフィールドが関連付けられるCRMオブジェクトタイプ（例：コンタクト、取引）。
        options:
          type: array
          items:
            $ref: '#/components/schemas/EnumeratedFieldOption'
        required:
          type: boolean
          description: ユーザーがフォームを送信する前にオプションを選択する必要があるかどうか。
      x-hubspot-sub-type-impl: true
    LegalConsentCheckbox:
      required:
        - label
        - required
        - subscriptionTypeId
      type: object
      properties:
        label:
          type: string
          description: フォームフィールドのメインラベル。
        required:
          type: boolean
          description: フォーム送信時にこのチェックボックスを必須とするかどうか。
        subscriptionTypeId:
          type: integer
          description: 同意チェックボックスと関連付けられた配信カテゴリーのID。
          format: int64
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: エラーの詳細に関連付けられているステータスコード
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: エラー条件に関する背景状況
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: エラーが見つかったフィールドまたはパラメーターの名前。
        message:
          type: string
          description: エラーと修正手順（該当する場合）を記した、人が理解できるメッセージ
        subCategory:
          type: string
          description: エラーに関する具体的な詳細が含まれる特定のカテゴリー
    DependentField:
      required:
        - dependentCondition
        - dependentField
      type: object
      properties:
        dependentCondition:
          $ref: '#/components/schemas/DependentFieldFilter'
        dependentField:
          description: 依存条件を満たすかどうかに基づいて、条件に応じて表示されるフォームフィールド。
          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: ブロックするEメールドメインのリスト。
          items:
            type: string
        useDefaultBlockList:
          type: boolean
          description: 無料のEメールプロバイダーをブロックするかどうか。
    PhoneFieldValidation:
      required:
        - maxAllowedDigits
        - minAllowedDigits
      type: object
      properties:
        maxAllowedDigits:
          type: integer
          description: 電話番号に許可される最大桁数。デフォルト：20。minAllowedDigits以上である必要があります。
          format: int32
        minAllowedDigits:
          type: integer
          description: 電話番号に必要な最小桁数。デフォルト：7。maxAllowedDigits以下である必要があります。
          format: int32
    NumberFieldValidation:
      required:
        - maxAllowedDigits
        - minAllowedDigits
      type: object
      properties:
        maxAllowedDigits:
          type: integer
          description: 数値フィールドの入力に許可される最大桁数。minAllowedDigits以上である必要があります。
          format: int32
        minAllowedDigits:
          type: integer
          description: 有効な数値フィールドの入力に必要な最小桁数。maxAllowedDigits以下である必要があります。
          format: int32
    EnumeratedFieldOption:
      required:
        - displayOrder
        - label
        - value
      type: object
      properties:
        description:
          type: string
          description: オプションに関する追加の説明テキスト。
        displayOrder:
          type: integer
          description: 選択肢を表示する順序。
          format: int32
        label:
          type: string
          description: この選択肢の表示ラベル。
        value:
          type: string
          description: この選択肢が選択された場合に送信される値。
    DependentFieldFilter:
      required:
        - operator
        - rangeEnd
        - rangeStart
        - value
        - values
      type: object
      properties:
        operator:
          type: string
          description: >-
            依存フィールドの条件の評価に使用される比較演算子。同等性（eq、neq）、文字列操作（contains、doesnt_contain、str_starts_with、str_ends_with）、数値比較（lt、lte、gt、gte）、範囲チェック（between、not_between）、集合演算（set_any、set_not_any、set_eq、set_neq）、時間に基づく条件（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: 範囲に基づく操作（between、not_between）の終了値。rangeStartと併せて指定する必要があります。
        rangeStart:
          type: string
          description: 範囲に基づく操作（between、not_between）の開始値。rangeEndと併せて指定する必要があります。
        value:
          type: string
          description: eq、neq、contains、lt、gt、その他の単一値比較演算子を使用している場合に比較対象となる単一値。
        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: ''

````