E-mail transacional
Preferências de assinatura v3
Preferências de assinatura v4
E-mails de marketing
Eventos de marketing
Campanhas
Formulários
Reuniões
curl --request POST \
--url https://api.hubapi.com/marketing/v3/forms/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"formType": "hubspot",
"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",
"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>"
},
"legalConsentOptions": {
"type": "none"
},
"archivedAt": "2023-11-07T05:31:56Z"
}
'{
"id": "409fa224-7fef-4507-b731-1eb3f508a3eb",
"name": "Join our mailing list",
"createdAt": "2020-09-22T07:13:28.102Z",
"updatedAt": "2020-09-22T07:13:28.102Z",
"archived": false,
"fieldGroups": [
{
"groupType": "default_group",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "email",
"label": "Email",
"required": true,
"hidden": false,
"fieldType": "email",
"validation": {
"blockedEmailDomains": [],
"useDefaultBlockList": false
}
}
]
},
{
"groupType": "default",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "firstname",
"label": "First name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
},
{
"objectTypeId": "0-1",
"name": "lastname",
"label": "Last name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
}
]
}
],
"configuration": {
"language": "en",
"cloneable": true,
"postSubmitAction": {
"type": "thank_you",
"value": "Thanks for joining our mailing list."
},
"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": "none"
},
"formType": "hubspot"
}Criar um formulário
Adicione um novo formulário “hubspot”
curl --request POST \
--url https://api.hubapi.com/marketing/v3/forms/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"formType": "hubspot",
"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",
"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>"
},
"legalConsentOptions": {
"type": "none"
},
"archivedAt": "2023-11-07T05:31:56Z"
}
'{
"id": "409fa224-7fef-4507-b731-1eb3f508a3eb",
"name": "Join our mailing list",
"createdAt": "2020-09-22T07:13:28.102Z",
"updatedAt": "2020-09-22T07:13:28.102Z",
"archived": false,
"fieldGroups": [
{
"groupType": "default_group",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "email",
"label": "Email",
"required": true,
"hidden": false,
"fieldType": "email",
"validation": {
"blockedEmailDomains": [],
"useDefaultBlockList": false
}
}
]
},
{
"groupType": "default",
"richTextType": "text",
"fields": [
{
"objectTypeId": "0-1",
"name": "firstname",
"label": "First name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
},
{
"objectTypeId": "0-1",
"name": "lastname",
"label": "Last name",
"required": false,
"hidden": false,
"fieldType": "single_line_text"
}
]
}
],
"configuration": {
"language": "en",
"cloneable": true,
"postSubmitAction": {
"type": "thank_you",
"value": "Thanks for joining our mailing list."
},
"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": "none"
},
"formType": "hubspot"
}Produtos suportados
Produtos suportados
Marketing Hub -Grátis
Sales Hub -Grátis
Service Hub -Grátis
Content Hub -GrátisEscopos Necessários
Escopos Necessários
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
hubspot Mostrar atributos filhos
Mostrar atributos filhos
Os campos de formulário incluídos no grupo
A form field used for collecting an email address.
- email
- phone
- mobile_phone
- single_line_text
- multi_line_text
- number
- single_checkbox
- multiple_checkboxes
- dropdown
- radio
- datepicker
- file
- payment_link_radio
Mostrar atributos filhos
Mostrar atributos filhos
Uma lista de outros campos a serem exibidos com base no valor preenchido para este campo.
Mostrar atributos filhos
Mostrar atributos filhos
A condition based on customer input
Mostrar atributos filhos
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.
- phone
- mobile_phone
- single_line_text
- multi_line_text
- number
- single_checkbox
- multiple_checkboxes
- dropdown
- radio
- datepicker
- file
- payment_link_radio
Mostrar atributos filhos
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
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
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
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
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 Response
successful operation
hubspot Mostrar atributos filhos
Mostrar atributos filhos
Os campos de formulário incluídos no grupo
A form field used for collecting an email address.
- email
- phone
- mobile_phone
- single_line_text
- multi_line_text
- number
- single_checkbox
- multiple_checkboxes
- dropdown
- radio
- datepicker
- file
- payment_link_radio
Mostrar atributos filhos
Mostrar atributos filhos
Uma lista de outros campos a serem exibidos com base no valor preenchido para este campo.
Mostrar atributos filhos
Mostrar atributos filhos
A condition based on customer input
Mostrar atributos filhos
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.
- phone
- mobile_phone
- single_line_text
- multi_line_text
- number
- single_checkbox
- multiple_checkboxes
- dropdown
- radio
- datepicker
- file
- payment_link_radio
Mostrar atributos filhos
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
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
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
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
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