curl --request PATCH \
--url https://api.hubapi.com/marketing/v3/forms/{formId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"archived": true,
"configuration": {
"allowLinkToResetKnownValues": true,
"archivable": true,
"cloneable": true,
"createNewContactForNewEmail": true,
"editable": true,
"language": "af",
"notifyContactOwner": true,
"notifyRecipients": [
"<string>"
],
"postSubmitAction": {
"type": "redirect_url",
"value": "<string>"
},
"prePopulateKnownValues": true,
"recaptchaEnabled": true,
"lifecycleStages": [
{
"objectTypeId": "<string>",
"value": "<string>"
}
]
},
"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>"
},
"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>"
}
'{
"id": "6eae0163-5362-4c0e-809c-b99a18678adc",
"name": "Register for event updates",
"createdAt": "2020-09-22T05:12:27.505Z",
"updatedAt": "2020-09-22T07:35:48.172Z",
"archived": false,
"fieldGroups": [
{
"groupType": "default_group",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "firstname",
"label": "First name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
},
{
"objectTypeId": "0-1",
"name": "email",
"label": "Email",
"required": true,
"hidden": false,
"fieldType": "email",
"validation": {
"blockedEmailDomains": [],
"useDefaultBlockList": false
}
}
]
},
{
"groupType": "progressive",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "age_group",
"label": "Age group",
"required": false,
"hidden": false,
"options": [
{
"label": "Under 18",
"value": "Under 18",
"description": "",
"displayOrder": 0
},
{
"label": "18-60",
"value": "18-60",
"description": "",
"displayOrder": 1
},
{
"label": "60+",
"value": "60+",
"description": "",
"displayOrder": 2
}
],
"fieldType": "dropdown"
}
]
}
],
"configuration": {
"language": "en",
"cloneable": true,
"postSubmitAction": {
"type": "thank_you",
"value": "Thanks for signing up for our updates"
},
"editable": true,
"archivable": true,
"recaptchaEnabled": false,
"notifyContactOwner": false,
"notifyRecipients": [
"2886602"
],
"createNewContactForNewEmail": false,
"prePopulateKnownValues": true,
"allowLinkToResetKnownValues": false,
"lifecycleStages": [
{
"objectTypeId": "0-1",
"value": "subscriber"
},
{
"objectTypeId": "0-2",
"value": "subscriber"
}
]
},
"displayOptions": {
"renderRawHtml": false,
"theme": "default_style",
"submitButtonText": "Submit",
"style": {
"fontFamily": "arial, helvetica, sans-serif",
"backgroundWidth": "100%",
"labelTextColor": "#33475b",
"labelTextSize": "13px",
"helpTextColor": "#7C98B6",
"helpTextSize": "11px",
"legalConsentTextColor": "#33475b",
"legalConsentTextSize": "14px",
"submitColor": "#ff7a59",
"submitAlignment": "left",
"submitFontColor": "#ffffff",
"submitSize": "12px"
},
"cssClass": "hs-form stacked"
},
"legalConsentOptions": {
"type": "explicit_consent_to_process",
"communicationConsentText": "<p>Fancy Forms, LLC is committed to protecting and respecting your privacy, and we’ll only use your personal information to administer your account and to provide the products and services you requested from us. From time to time, we would like to contact you about our products and services, as well as other content that may be of interest to you. If you consent to us contacting you for this purpose, please tick below to say how you would like us to contact you:</p>",
"communicationsCheckboxes": [
{
"required": false,
"subscriptionTypeId": 3883363,
"label": "<p>I agree to receive other communications from Fancy Forms, LLC.</p>"
}
],
"consentToProcessText": "<p>In order to provide you the content requested, we need to store and process your personal data. If you consent to us storing your personal data for this purpose, please tick the checkbox below.</p>",
"consentToProcessCheckboxLabel": "<p>I agree to allow Fancy Forms, LLC to store and process my personal data.</p>",
"privacyText": "<p>You can unsubscribe from these communications at any time. For more information on how to unsubscribe, our privacy practices, and how we are committed to protecting and respecting your privacy, please review our Privacy Policy.</p>"
},
"formType": "hubspot"
}Atualize alguns dos componentes de definição do formulário
curl --request PATCH \
--url https://api.hubapi.com/marketing/v3/forms/{formId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"archived": true,
"configuration": {
"allowLinkToResetKnownValues": true,
"archivable": true,
"cloneable": true,
"createNewContactForNewEmail": true,
"editable": true,
"language": "af",
"notifyContactOwner": true,
"notifyRecipients": [
"<string>"
],
"postSubmitAction": {
"type": "redirect_url",
"value": "<string>"
},
"prePopulateKnownValues": true,
"recaptchaEnabled": true,
"lifecycleStages": [
{
"objectTypeId": "<string>",
"value": "<string>"
}
]
},
"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>"
},
"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>"
}
'{
"id": "6eae0163-5362-4c0e-809c-b99a18678adc",
"name": "Register for event updates",
"createdAt": "2020-09-22T05:12:27.505Z",
"updatedAt": "2020-09-22T07:35:48.172Z",
"archived": false,
"fieldGroups": [
{
"groupType": "default_group",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "firstname",
"label": "First name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
},
{
"objectTypeId": "0-1",
"name": "email",
"label": "Email",
"required": true,
"hidden": false,
"fieldType": "email",
"validation": {
"blockedEmailDomains": [],
"useDefaultBlockList": false
}
}
]
},
{
"groupType": "progressive",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "age_group",
"label": "Age group",
"required": false,
"hidden": false,
"options": [
{
"label": "Under 18",
"value": "Under 18",
"description": "",
"displayOrder": 0
},
{
"label": "18-60",
"value": "18-60",
"description": "",
"displayOrder": 1
},
{
"label": "60+",
"value": "60+",
"description": "",
"displayOrder": 2
}
],
"fieldType": "dropdown"
}
]
}
],
"configuration": {
"language": "en",
"cloneable": true,
"postSubmitAction": {
"type": "thank_you",
"value": "Thanks for signing up for our updates"
},
"editable": true,
"archivable": true,
"recaptchaEnabled": false,
"notifyContactOwner": false,
"notifyRecipients": [
"2886602"
],
"createNewContactForNewEmail": false,
"prePopulateKnownValues": true,
"allowLinkToResetKnownValues": false,
"lifecycleStages": [
{
"objectTypeId": "0-1",
"value": "subscriber"
},
{
"objectTypeId": "0-2",
"value": "subscriber"
}
]
},
"displayOptions": {
"renderRawHtml": false,
"theme": "default_style",
"submitButtonText": "Submit",
"style": {
"fontFamily": "arial, helvetica, sans-serif",
"backgroundWidth": "100%",
"labelTextColor": "#33475b",
"labelTextSize": "13px",
"helpTextColor": "#7C98B6",
"helpTextSize": "11px",
"legalConsentTextColor": "#33475b",
"legalConsentTextSize": "14px",
"submitColor": "#ff7a59",
"submitAlignment": "left",
"submitFontColor": "#ffffff",
"submitSize": "12px"
},
"cssClass": "hs-form stacked"
},
"legalConsentOptions": {
"type": "explicit_consent_to_process",
"communicationConsentText": "<p>Fancy Forms, LLC is committed to protecting and respecting your privacy, and we’ll only use your personal information to administer your account and to provide the products and services you requested from us. From time to time, we would like to contact you about our products and services, as well as other content that may be of interest to you. If you consent to us contacting you for this purpose, please tick below to say how you would like us to contact you:</p>",
"communicationsCheckboxes": [
{
"required": false,
"subscriptionTypeId": 3883363,
"label": "<p>I agree to receive other communications from Fancy Forms, LLC.</p>"
}
],
"consentToProcessText": "<p>In order to provide you the content requested, we need to store and process your personal data. If you consent to us storing your personal data for this purpose, please tick the checkbox below.</p>",
"consentToProcessCheckboxLabel": "<p>I agree to allow Fancy Forms, LLC to store and process my personal data.</p>",
"privacyText": "<p>You can unsubscribe from these communications at any time. For more information on how to unsubscribe, our privacy practices, and how we are committed to protecting and respecting your privacy, please review our Privacy Policy.</p>"
},
"formType": "hubspot"
}Produtos suportados
Escopos Necessários
The access token received from the authorization server in the OAuth 2.0 flow.
O ID do formulário a ser atualizado.
Se este formulário é arquivado ou não.
Mostrar atributos filhos
Se um link de redefinição deve ser adicionado ao formulário. Remove qualquer conteúdo preenchido previamente no formulário e cria um novo contato ao enviar.
Se o formulário pode ser arquivado.
Se o formulário pode ser clonado.
Se um novo contato deve ser criado quando um formulário é enviado com um endereço de e-mail que não corresponde a nenhum endereço em seus registros de contato existentes.
Se o formulário pode ser editado.
O idioma do formulário.
af, ar-eg, bg, bn, ca-es, cs, da, de, el, en, es, es-mx, fi, fr, fr-ca, he-il, hr, hu, id, it, ja, ko, lt, ms, nl, no-no, pl, pt, pt-br, ro, ru, sk, sl, sv, th, tl, tr, uk, vi, zh-cn, zh-hk, zh-tw Se um e-mail de notificação deve ser enviado ao proprietário do contato quando um envio é recebido.
A lista de IDs de usuários para receber um e-mail de notificação quando um envio for recebido.
What should happen after the customer submits the form.
Mostrar atributos filhos
Se os campos de contato devem ser preenchidos previamente com informações conhecidas quando um contato retorna ao seu site.
Se o CAPTCHA (prevenção de spam) está habilitado.
Options for styling the form.
Mostrar atributos filhos
Se o formulário será renderizado como HTML bruto em vez de dentro de um iFrame.
Styling options for the form
Mostrar atributos filhos
center, left, right O texto exibido no botão de envio do formulário.
O tema usado para estilizar os campos de entrada. Não se aplicará se o formulário for adicionado a uma página do HubSpot CMS.
canvas, default_style, legacy, linear, round, sharp Os campos no formulário, agrupados em linhas.
Mostrar atributos filhos
Os campos de formulário incluídos no grupo
A form field used for collecting an email address.
Mostrar atributos filhos
Uma lista de outros campos a serem exibidos com base no valor preenchido para este campo.
Mostrar atributos filhos
A condition based on customer input
Mostrar atributos filhos
between, contains, doesnt_contain, eq, gt, gte, is_not_empty, lt, lte, neq, not_between, set_all, set_any, set_eq, set_neq, set_not_all, set_not_any, str_ends_with, str_starts_with, within_time, within_time_reverse A form field used for collecting a phone number.
Mostrar atributos filhos
Uma lista de outros campos a serem exibidos com base no valor preenchido para este campo.
Determina como o campo será exibido e validado.
phone Se um campo deve ser ocultado ou não. Campos ocultos não aparecerão no formulário, mas podem ser usados para transmitir um valor a uma propriedade sem exigir que o cliente o preencha.
O rótulo principal do campo do formulário.
O identificador do campo. Em combinação com o ID do tipo de objeto, ele deve ser exclusivo.
Um ID exclusivo para o tipo de objeto do CRM deste campo. Por exemplo, um campo de CONTACT terá o ID de tipo de objeto 0-1.
Se um valor para este campo é necessário ao enviar o formulário.
Se um menu suspenso de código de país deve ser exibido ao lado do campo de telefone.
O valor preenchido por padrão. Este valor será enviado, a menos que o cliente o modifique.
Texto adicional que ajuda o cliente a preencher o campo.
O texto de prompt exibido quando o campo não está preenchido.
Determina como o campo será exibido e validado.
email Se um campo deve ser ocultado ou não. Campos ocultos não aparecerão no formulário, mas podem ser usados para transmitir um valor a uma propriedade sem exigir que o cliente o preencha.
O rótulo principal do campo do formulário.
O identificador do campo. Em combinação com o ID do tipo de objeto, ele deve ser exclusivo.
Um ID exclusivo para o tipo de objeto do CRM deste campo. Por exemplo, um campo de CONTACT terá o ID de tipo de objeto 0-1.
Se um valor para este campo é necessário ao enviar o formulário.
Describes how an email address should be validated.
O valor preenchido por padrão. Este valor será enviado, a menos que o cliente o modifique.
Texto adicional que ajuda o cliente a preencher o campo.
O texto de prompt exibido quando o campo não está preenchido.
default_group, progressive, queued O tipo de rich text incluído. O valor padrão é texto.
image, text Um bloco de rich text ou uma imagem. Podem ser usados para adicionar informações extras para os clientes que preenchem o formulário. Se o grupo de campos incluir campos, o rich text será exibido antes dos campos.
O nome do formulário. Espera-se que seja exclusivo para um hub.
successful operation
hubspot Mostrar atributos filhos
Os campos de formulário incluídos no grupo
A form field used for collecting an email address.
Mostrar atributos filhos
Uma lista de outros campos a serem exibidos com base no valor preenchido para este campo.
Mostrar atributos filhos
A condition based on customer input
Mostrar atributos filhos
between, contains, doesnt_contain, eq, gt, gte, is_not_empty, lt, lte, neq, not_between, set_all, set_any, set_eq, set_neq, set_not_all, set_not_any, str_ends_with, str_starts_with, within_time, within_time_reverse A form field used for collecting a phone number.
Mostrar atributos filhos
Uma lista de outros campos a serem exibidos com base no valor preenchido para este campo.
Determina como o campo será exibido e validado.
phone Se um campo deve ser ocultado ou não. Campos ocultos não aparecerão no formulário, mas podem ser usados para transmitir um valor a uma propriedade sem exigir que o cliente o preencha.
O rótulo principal do campo do formulário.
O identificador do campo. Em combinação com o ID do tipo de objeto, ele deve ser exclusivo.
Um ID exclusivo para o tipo de objeto do CRM deste campo. Por exemplo, um campo de CONTACT terá o ID de tipo de objeto 0-1.
Se um valor para este campo é necessário ao enviar o formulário.
Se um menu suspenso de código de país deve ser exibido ao lado do campo de telefone.
O valor preenchido por padrão. Este valor será enviado, a menos que o cliente o modifique.
Texto adicional que ajuda o cliente a preencher o campo.
O texto de prompt exibido quando o campo não está preenchido.
Determina como o campo será exibido e validado.
email Se um campo deve ser ocultado ou não. Campos ocultos não aparecerão no formulário, mas podem ser usados para transmitir um valor a uma propriedade sem exigir que o cliente o preencha.
O rótulo principal do campo do formulário.
O identificador do campo. Em combinação com o ID do tipo de objeto, ele deve ser exclusivo.
Um ID exclusivo para o tipo de objeto do CRM deste campo. Por exemplo, um campo de CONTACT terá o ID de tipo de objeto 0-1.
Se um valor para este campo é necessário ao enviar o formulário.
Describes how an email address should be validated.
O valor preenchido por padrão. Este valor será enviado, a menos que o cliente o modifique.
Texto adicional que ajuda o cliente a preencher o campo.
O texto de prompt exibido quando o campo não está preenchido.
default_group, progressive, queued O tipo de rich text incluído. O valor padrão é texto.
image, text Um bloco de rich text ou uma imagem. Podem ser usados para adicionar informações extras para os clientes que preenchem o formulário. Se o grupo de campos incluir campos, o rich text será exibido antes dos campos.
Mostrar atributos filhos
Se um link de redefinição deve ser adicionado ao formulário. Remove qualquer conteúdo preenchido previamente no formulário e cria um novo contato ao enviar.
Se o formulário pode ser arquivado.
Se o formulário pode ser clonado.
Se um novo contato deve ser criado quando um formulário é enviado com um endereço de e-mail que não corresponde a nenhum endereço em seus registros de contato existentes.
Se o formulário pode ser editado.
O idioma do formulário.
af, ar-eg, bg, bn, ca-es, cs, da, de, el, en, es, es-mx, fi, fr, fr-ca, he-il, hr, hu, id, it, ja, ko, lt, ms, nl, no-no, pl, pt, pt-br, ro, ru, sk, sl, sv, th, tl, tr, uk, vi, zh-cn, zh-hk, zh-tw Se um e-mail de notificação deve ser enviado ao proprietário do contato quando um envio é recebido.
A lista de IDs de usuários para receber um e-mail de notificação quando um envio for recebido.
What should happen after the customer submits the form.
Mostrar atributos filhos
Se os campos de contato devem ser preenchidos previamente com informações conhecidas quando um contato retorna ao seu site.
Se o CAPTCHA (prevenção de spam) está habilitado.
Options for styling the form.
Mostrar atributos filhos
Se o formulário será renderizado como HTML bruto em vez de dentro de um iFrame.
Styling options for the form
Mostrar atributos filhos
center, left, right O texto exibido no botão de envio do formulário.
O tema usado para estilizar os campos de entrada. Não se aplicará se o formulário for adicionado a uma página do HubSpot CMS.
canvas, default_style, legacy, linear, round, sharp