Aviso: este é um comunicado histórico, publicado em 23/06/2023. As mudanças descritas abaixo já estão em vigor e nenhuma ação é necessária. O conteúdo é mantido apenas para consulta. Para a estrutura atual do endpoint, consulte a documentação técnica de formulários customizados.
A documentação técnica do endpoint de formulários customizados pode ser conferida neste link.
ALTERAÇÕES NOS ATRIBUTOS JÁ EXISTENTES
Confira na tabela abaixo a relação dos atributos que passaram por alterações, sendo a primeira coluna o antigo atributo, e a segunda coluna o novo atributo.
Antigo atributo | Novo atributo | Tipo | Descrição |
"title" | "page_title" | String | Título do formulário público |
"content" | "page_content" | String | Texto de conteúdo do formulário público |
"background" | "page_background_color" | String | Cor de fundo da página do formulário público |
"text_color" | "page_text_color" | String | Cor da fonte de texto do formulário público |
NOVOS ATRIBUTOS
A nova versão de formulários customizados possibilita um maior grau de customização do formulário público. Para isso, novos atributos foram desenvolvidos. São eles:
Atributo | Tipo | Descrição |
"page_logo_url" | String | Imagem padrão do formulário |
"form_background_color" | String | Cor de fundo do formulário |
"form_text_color" | String | Cor da fonte de texto do conteúdo da página do formulário público |
"form_button_background_color" | String | Cor de fundo do botão do formulário |
"form_button_text_color" | String | Cor da fonte de texto do botão do formulário |
"form_with_rounded_borders" | Booleano | Adicionar formato arredondado nas bordas do formulário |
"form_show_icons" | Booleano | Exibir os ícones nos campos |
ALTERAÇÕES NO ARRAY DE VÍNCULO DE CAMPOS (NATIVOS E CUSTOMIZADOS)
A estrutura dos atributos para realizar o vínculo dos campos nativos e customizados ao formulário também passou por mudanças.
Confira na tabela abaixo os atributos que foram removidos ou substituídos:
Antigo atributo | Descrição | Status | Novo atributo (substituto) |
"is_native" | Define se o campo é nativo ou customizado | Atributo removido | Não existe |
"type_name" | Nome do tipo de campo | Atributo removido | Não existe |
"values" | Valor do campo | Atributo removido | customField.values (quando o campo for campo customizado) |
"decimal_places" | Quantidade de casas decimais aceitas no valor do campo | Atributo removido | customField.decimal_places (quando o campo for campo customizado) |
"formula" | Estrutura da fórmula do campo customizado | Atributo removido | customField.formula (quando o campo for campo customizado) |
"description" | Descrição do campo | Atributo removido | customField.description (quando o campo for campo customizado) |
"currency_id" | ID da moeda do campo, caso seja um campo de moeda fiduciária | Atributo removido | customField.currency_id (quando o campo for campo customizado) |
"thousand_sep" | Separador de milhar | Atributo removido | customField.thousand_sep (quando o campo for campo customizado) |
"belongs" | Inteiro relacionado ao vínculo às entidades "pessoas", "empresas" ou "pessoas" | Atributo removido | customField.belongs (quando o campo for campo customizado) |
"field" | Nome da entidade e campo nativo da entidade | Atributo removido | Não existe |
"type" | Inteiro relacionado ao tipo de campo, customizado ou nativo | Atributo removido | Não existe |
Confira os novos atributos (não editáveis, apenas para leitura):
Atributo | Descrição |
"account_id" | ID da conta do CRM PipeRun |
"created_at" | Data e hora de criação do formulário customizado |
"updated_at" | Data e hora da última atualização do formulário customizado |
Por fim, também foi alterada a estrutura para vínculo dos campos nativos e customizados. Confira abaixo uma tabela com os novos atributos:
Atributo | Tipo | Descrição |
"fields" | Array de objetos | Array de objetos contendo os campos nativos ou customizados que compõem o formulário |
"native_field_entity" | Inteiro | Inteiro relacionado ao tipo de vínculo às entidades nativas, sendo elas: |
"native_field_name" | String | Nome do campo nativo |
"native_field_type" | Inteiro | Inteiro relacionado ao tipo do campo nativo. As opções disponíveis estão listadas na tabela abaixo |
Por fim, confira as opções de valores disponíveis para o atributo "native_field_type", referente ao tipo de campo nativo.
Valor | Descrição |
"100" | Texto |
"101" | Texto longo |
"102" | Número |
"103" | Data |
"104" | URL |
"105" | |
"200" | Valor |
"201" | CPF |
"202" | CNPJ |
"203" | CEP |
"204" | E-mails |
"205" | Telefones |
"206" | Gênero |
"207" | Upload de imagem |
"300" | Cidade/UF |
"301" | CNAE principal |
"302" | CNAE secundario |
"303" | Segmento |
"304" | Tag |
"305" | Origem |
"306" | Probabilidade |
"307" | Temperatura |
"308" | Tipo de empresa |
"309" | Status da empresa |
"310" | Situação da empresa |
"311" | Modelo touch da empresa |
EXEMPLO DE JSON PARA CRIAÇÃO DE FORMULÁRIO
A documentação técnica do endpoint de formulários customizados pode ser conferida neste link.
Em caso de dúvidas, chame nossa equipe no chat. 😉