v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Adicionar formulário customizado

post/customForms

Request body

namestring required

Nome do formulário customizado.

typeinteger required

Entidade de vínculo com o formulário: 1: oportunidades, 2: empresas, 3: pessoas.

statusboolean required

Status ativo/inativo do formulário customizado: false: inativo, true: ativo.

page_titlestring

Título do formulário.

page_contentstring

Texto (conteúdo) do formulário.

page_background_colorstring

Cor de fundo da página do formulário público.

page_text_colorstring

Cor do texto do formulário.

page_logo_urlstring

URL apontando para imagem padrão do formulário. Caso não seja informada, será considerado o logotipo padrão da conta.

form_background_colorstring

Cor de fundo do formulário.

form_text_colorstring

Cor da fonte de texto do conteúdo da página do formulário público.

form_button_background_colorstring

Cor de fundo do botão do formulário.

form_button_text_colorstring

Cor da fonte de texto do botão do formulário.

form_with_rounded_bordersboolean

Adicionar formato arredondado nas bordas do formulário.

form_show_iconsboolean

Exibir os ícones nos campos do formulário

Response

201

idinteger

account_idinteger

namestring

typeinteger

statusboolean

page_titlestring

page_contentstring

page_background_colorstring

page_text_colorstring

{"stackTrail":"paths:/customForms:post:responses:201:content:application/json:schema:properties:page_logo_url","oasType":"schema","type":"unknown"}

form_background_colorstring

form_text_colorstring

form_button_background_colorstring

form_button_text_colorstring

form_with_rounded_bordersinteger

form_show_iconsboolean

Example response

{
  "id": 27403,
  "account_id": 1234567890,
  "name": "Formulário de exemplo",
  "type": 1,
  "status": true,
  "page_title": "Título exemplo",
  "page_content": "Texto de exemplo",
  "page_background_color": "#FFFFFF",
  "page_text_color": "#000000",
  "form_background_color": "#E7E7E7",
  "form_text_color": "#000000",
  "form_button_background_color": "#ed5565",
  "form_button_text_color": "#FFFFFF",
  "form_with_rounded_borders": 1,
  "form_show_icons": true,
  "fields": [
    {
      "id": 193810,
      "account_id": 1234567890,
      "custom_form_id": 27403,
      "native_field_name": "title",
      "native_field_type": 100,
      "native_field_entity": 1,
      "order": 1,
      "created_at": "2023-06-22 18:02:44",
      "updated_at": "2023-06-22 18:02:44"
    }
  ],
  "activityTypes": [
    {
      "id": 5938,
      "account_id": 1234567890,
      "name": "E-mail",
      "icon": "envelope",
      "active": 1
    }
  ],
  "pipelines": [
    {
      "id": 1930,
      "account_id": 1234567890,
      "funnel_type_name": "Vendas",
      "user_id": 2417,
      "name": "Funil de vendas",
      "description": "Funil de vendas principal",
      "visibility": 2
    }
  ]
}