---
title: "Atualizar formulário customizado"
method: PUT
path: "/customForms/{id}"
---

# Atualizar formulário customizado

`PUT /customForms/{id}`

## Path parameters

- `id` integer, required

## Request body

- object
  - `name` string — Nome do formulário customizado.
  - `type` integer — Entidade de vínculo com o formulário: 1: oportunidades, 2: empresas, 3: pessoas.
  - `status` boolean — Status ativo/inativo do formulário customizado: false: inativo, true: ativo.
  - `pipelines` object[] — Array contendo os IDs dos funis onde o formulário estará disponível.
    - `id` integer — ID do funil de vinculo com o formulário.
  - `activityTypes` object[] — Array contendo os IDs dos tipos de atividades cujo formulário será exibido após concluir ou marcar como "no-show" a atividade no aplicativo mobile.
    - `id` integer — ID do tipo de atividade cujo formulário será exibido após concluir ou marcar como "no-show" a atividade no aplicativo mobile.
  - `page_title` string — Título do formulário.
  - `page_content` string — Texto (conteúdo) do formulário.
  - `page_background_color` string — Cor de fundo da página do formulário público.
  - `page_text_color` string — Cor do texto do formulário.
  - `form_text_color` string — Cor da fonte de texto do conteúdo da página do formulário público.
  - `page_logo_url` string — URL apontando para imagem padrão do formulário. Caso não seja informada, será considerado o logotipo padrão da conta.
  - `form_background_color` string — Cor de fundo do formulário.
  - `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` boolean — Adicionar formato arredondado nas bordas do formulário.
  - `form_show_icons` boolean — Exibir os ícones nos campos do formulário
  - `fields` object — Array contendo os campos (nativos ou customizados) do formulário. A estrutura do array tem como chave a posição do campo no formulário e como valor as informações referentes ao campo utilizado.
    - `0` object
      - `required` boolean — Definir preenchimento de campo como obrigatório ou não obrigatório: false = não obrigatório, true = obrigatório.
      - `custom_field_id` integer — ID do campo customizado (caso não seja um campo nativo)
      - `native_field_type` integer — Tipo do campo nativo (caso não seja um campo customizado). Confira as opções disponíveis na página "[Considerações - Tipo de campo nativo](https://vendas.developers.pipe.run/reference/considera%C3%A7%C3%B5es-tipo-de-campo-nativo)".
      - `native_field_entity` integer — Tipo de vínculo do campo nativo com as entidades do sistema, sendo elas: 1: oportunidades, 2: empresas, 3: pessoas.
    - `1` object
      - `required` boolean — Definir preenchimento de campo como obrigatório ou não obrigatório: false = não obrigatório, true = obrigatório.
      - `custom_field_id` integer — ID do campo customizado (caso não seja um campo nativo)
      - `native_field_type` integer — Tipo do campo nativo (caso não seja um campo customizado). Confira as opções disponíveis na página "[Considerações - Tipo de campo nativo](https://vendas.developers.pipe.run/reference/considera%C3%A7%C3%B5es-tipo-de-campo-nativo)".
      - `native_field_entity` integer — Tipo de vínculo do campo nativo com as entidades do sistema, sendo elas: 1: oportunidades, 2: empresas, 3: pessoas.
    - `2` object
      - `required` boolean — Definir preenchimento de campo como obrigatório ou não obrigatório: false = não obrigatório, true = obrigatório.
      - `custom_field_id` integer — ID do campo customizado (caso não seja um campo nativo)
      - `native_field_type` integer — Tipo do campo nativo (caso não seja um campo customizado). Confira as opções disponíveis na página "[Considerações - Tipo de campo nativo](https://vendas.developers.pipe.run/reference/considera%C3%A7%C3%B5es-tipo-de-campo-nativo)".
      - `native_field_entity` integer — Tipo de vínculo do campo nativo com as entidades do sistema, sendo elas: 1: oportunidades, 2: empresas, 3: pessoas.
    - `3` object
      - `required` boolean — Definir preenchimento de campo como obrigatório ou não obrigatório: false = não obrigatório, true = obrigatório.
      - `custom_field_id` integer — ID do campo customizado (caso não seja um campo nativo)
      - `native_field_type` integer — Tipo do campo nativo (caso não seja um campo customizado). Confira as opções disponíveis na página "[Considerações - Tipo de campo nativo](https://vendas.developers.pipe.run/reference/considera%C3%A7%C3%B5es-tipo-de-campo-nativo)".
      - `native_field_entity` integer — Tipo de vínculo do campo nativo com as entidades do sistema, sendo elas: 1: oportunidades, 2: empresas, 3: pessoas.
    - `4` object
      - `required` boolean — Definir preenchimento de campo como obrigatório ou não obrigatório: false = não obrigatório, true = obrigatório.
      - `custom_field_id` integer — ID do campo customizado (caso não seja um campo nativo)
      - `native_field_type` integer — Tipo do campo nativo (caso não seja um campo customizado). Confira as opções disponíveis na página "[Considerações - Tipo de campo nativo](https://vendas.developers.pipe.run/reference/considera%C3%A7%C3%B5es-tipo-de-campo-nativo)".
      - `native_field_entity` integer — Tipo de vínculo do campo nativo com as entidades do sistema, sendo elas: 1: oportunidades, 2: empresas, 3: pessoas.
    - `5` object
      - `required` boolean — Definir preenchimento de campo como obrigatório ou não obrigatório: false = não obrigatório, true = obrigatório.
      - `custom_field_id` integer — ID do campo customizado (caso não seja um campo nativo)
      - `native_field_type` integer — Tipo do campo nativo (caso não seja um campo customizado). Confira as opções disponíveis na página "[Considerações - Tipo de campo nativo](https://vendas.developers.pipe.run/reference/considera%C3%A7%C3%B5es-tipo-de-campo-nativo)".
      - `native_field_entity` integer — Tipo de vínculo do campo nativo com as entidades do sistema, sendo elas: 1: oportunidades, 2: empresas, 3: pessoas.
    - `6` object
      - `required` boolean — Definir preenchimento de campo como obrigatório ou não obrigatório: false = não obrigatório, true = obrigatório.
      - `custom_field_id` integer — ID do campo customizado (caso não seja um campo nativo)
      - `native_field_type` integer — Tipo do campo nativo (caso não seja um campo customizado). Confira as opções disponíveis na página "[Considerações - Tipo de campo nativo](https://vendas.developers.pipe.run/reference/considera%C3%A7%C3%B5es-tipo-de-campo-nativo)".
      - `native_field_entity` integer — Tipo de vínculo do campo nativo com as entidades do sistema, sendo elas: 1: oportunidades, 2: empresas, 3: pessoas.
    - `7` object
      - `required` boolean — Definir preenchimento de campo como obrigatório ou não obrigatório: false = não obrigatório, true = obrigatório.
      - `custom_field_id` integer — ID do campo customizado (caso não seja um campo nativo)
      - `native_field_type` integer — Tipo do campo nativo (caso não seja um campo customizado). Confira as opções disponíveis na página "[Considerações - Tipo de campo nativo](https://vendas.developers.pipe.run/reference/considera%C3%A7%C3%B5es-tipo-de-campo-nativo)".
      - `native_field_entity` integer — Tipo de vínculo do campo nativo com as entidades do sistema, sendo elas: 1: oportunidades, 2: empresas, 3: pessoas.
    - `8` object

## Response `200`

200

- object
  - `id` integer
  - `account_id` integer
  - `name` string
  - `type` integer
  - `status` boolean
  - `page_title` string
  - `page_content` string
  - `page_background_color` string
  - `page_text_color` string
  - `page_logo_url` unknown
  - `form_background_color` string
  - `form_text_color` string
  - `form_button_background_color` string
  - `form_button_text_color` string
  - `form_with_rounded_borders` integer
  - `form_show_icons` boolean
  - `fields` object[]
    - `id` integer
    - `account_id` integer
    - `custom_form_id` integer
    - `custom_field_id` unknown
    - `native_field_name` string
    - `native_field_type` integer
    - `native_field_entity` integer
    - `required` boolean
    - `order` integer
    - `created_at` string
    - `updated_at` string
  - `activityTypes` object[]
    - `id` integer
    - `account_id` integer
    - `activity_type_id` unknown
    - `name` string
    - `icon` string
    - `description` unknown
    - `active` integer
    - `send_integration` integer
  - `pipelines` object[]
    - `id` integer
    - `account_id` integer
    - `funnel_type` integer
    - `funnel_type_name` string
    - `user_id` integer
    - `name` string
    - `description` string
    - `order` integer
    - `is_main` boolean
    - `limit_time` integer
    - `visibility` integer

## Other responses

- `404` — 404
- `422` — 422

---

[API](https://skmtc.net/pipe/apis/application-json.md) · [All operations](https://skmtc.net/pipe/apis/application-json/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pipe/application-json/versions/0a130198f0a3/schema)