Actualizar parcialmente una definición de formulario

Actualizar algunos de los componentes de la definición del formulario

PATCH /marketing/v3/forms/{formId}

Actualizar parcialmente una definición de formulario

cURL

curl --request PATCH \
  --url https://api.hubapi.com/marketing/v3/forms/{formId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "archived": true,
  "fieldGroups": [
    {
      "fields": [
        {
          "dependentFields": [
            {
              "dependentCondition": {
                "operator": "between",
                "rangeEnd": "<string>",
                "rangeStart": "<string>",
                "value": "<string>",
                "values": [
                  "<string>"
                ]
              },
              "dependentField": "<unknown>"
            }
          ],
          "fieldType": "email",
          "hidden": true,
          "label": "<string>",
          "name": "<string>",
          "objectTypeId": "<string>",
          "required": true,
          "validation": {
            "blockedEmailDomains": [
              "<string>"
            ],
            "useDefaultBlockList": true
          },
          "defaultValue": "<string>",
          "description": "<string>",
          "placeholder": "<string>"
        }
      ],
      "groupType": "default_group",
      "richTextType": "image",
      "richText": "<string>"
    }
  ],
  "legalConsentOptions": {
    "type": "none"
  },
  "name": "<string>"
}
'

200

{
  "formType": "hubspot",
  "id": "<string>",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "archived": true,
  "fieldGroups": [
    {
      "fields": [
        {
          "dependentFields": [
            {
              "dependentCondition": {
                "operator": "between",
                "rangeEnd": "<string>",
                "rangeStart": "<string>",
                "value": "<string>",
                "values": [
                  "<string>"
                ]
              },
              "dependentField": "<unknown>"
            }
          ],
          "fieldType": "email",
          "hidden": true,
          "label": "<string>",
          "name": "<string>",
          "objectTypeId": "<string>",
          "required": true,
          "validation": {
            "blockedEmailDomains": [
              "<string>"
            ],
            "useDefaultBlockList": true
          },
          "defaultValue": "<string>",
          "description": "<string>",
          "placeholder": "<string>"
        }
      ],
      "groupType": "default_group",
      "richTextType": "image",
      "richText": "<string>"
    }
  ],
  "configuration": {
    "allowLinkToResetKnownValues": true,
    "archivable": true,
    "cloneable": true,
    "createNewContactForNewEmail": true,
    "editable": true,
    "language": "af",
    "lifecycleStages": [
      {
        "objectTypeId": "<string>",
        "value": "<string>"
      }
    ],
    "notifyContactOwner": true,
    "notifyRecipients": [
      "<string>"
    ],
    "postSubmitAction": {
      "type": "redirect_url",
      "value": "<string>"
    },
    "prePopulateKnownValues": true,
    "recaptchaEnabled": true,
    "embedType": "V3"
  },
  "displayOptions": {
    "renderRawHtml": true,
    "style": {
      "backgroundWidth": "<string>",
      "fontFamily": "<string>",
      "helpTextColor": "<string>",
      "helpTextSize": "<string>",
      "labelTextColor": "<string>",
      "labelTextSize": "<string>",
      "legalConsentTextColor": "<string>",
      "legalConsentTextSize": "<string>",
      "submitAlignment": "center",
      "submitColor": "<string>",
      "submitFontColor": "<string>",
      "submitSize": "<string>"
    },
    "submitButtonText": "<string>",
    "theme": "canvas",
    "cssClass": "<string>"
  },
  "legalConsentOptions": {
    "type": "none"
  },
  "archivedAt": "2023-11-07T05:31:56Z"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.

Marketing Hub -Gratuito

Sales Hub -Gratuito

Service Hub -Gratuito

Content Hub -Gratuito

Ámbitos Requeridos

Autorizaciones

oauth2private_apps

Authorization · string · header · requerido

The access token received from the authorization server in the OAuth 2.0 flow.

Parámetros de ruta

formId · string · requerido

Cuerpo

application/json

archived · boolean

Decidir si este formulario está archivado.

configuration · object

Show child attributes

displayOptions · object

Show child attributes

fieldGroups · object[]

Los campos del formulario, agrupados en filas.

Show child attributes

legalConsentOptions · none · object

Configuración de las opciones de cumplimiento de consentimiento legal y tratamiento de datos. Admite tipos: none, legitimate_interest, explicit_consent_to_process, implicit_consent_to_process.

none

legitimate_interest

explicit_consent_to_process

implicit_consent_to_process

Show child attributes

name · string

El nombre del formulario. Se espera que sea único para un hub.

Respuesta

200

application/json

successful operation

formType · enum<string> · predeterminado: hubspot · requerido

Opciones disponibles: hubspot

id · string · requerido

name · string · requerido

createdAt · string<date-time> · requerido

updatedAt · string<date-time> · requerido

archived · boolean · requerido

fieldGroups · object[] · requerido

Show child attributes

configuration · object · requerido

Show child attributes

displayOptions · object · requerido

Show child attributes

legalConsentOptions · none · object · requerido

none

legitimate_interest

explicit_consent_to_process

implicit_consent_to_process

Show child attributes

archivedAt · string<date-time>