Skip to main content
Cada item de form_answers leva o id do campo e o answer. O id vem da leitura. Esta página é o formato de answer para os 21 tipos. O endereço do formulário (o pivot) fica em Formulários dinâmicos e o pivot. A definição do campo (type, options, is_multiple) fica em Criar e editar formulários pela API. Os exemplos abaixo são só o valor de answer no corpo da gravação. Checkbox, link, anexo, usuário, contato, cliente e projeto usam sempre um array, mesmo com um único item. Com is_multiple desligado, envie um array de um elemento. No checkbox, is_multiple não limita: o array pode trazer várias opções.

Texto e números

Texto curto

short_text. Uma string.

Texto longo

long_text. Uma string. Quebras de linha entram no texto.

Texto com formatação

rich_text. Markdown ou o documento do editor, no formato TipTap.
Na leitura, o mesmo campo também devolve answer_markdown.

Numérico

number. Um número JSON ou uma string numérica. Texto que não é número é recusado.

Moeda

currency. O formulário grava um número JSON em real (BRL), com duas casas, de 0 a 999999999999.99. 1500.5 é R$ 1.500,50. O input não aceita valor negativo.

Contador

counter. Um número JSON, no mesmo formato de Numérico.
Só é possível responder este campo na ação de automação Atualizar contador.

Escolha entre opções

O texto do answer é o texto da opção, exatamente como está em options. Não é um id. Opção que não existe na lista do campo é recusada.

Seleção de lista

select. Uma string, uma das opções.

Seleção de única

radio. Uma string, uma das opções.

Checkbox

checkbox. Array com as opções marcadas. Uma string JSON desse array também é aceita. Uma opção solta, fora do array, é recusada.

Matriz

matrix. Objeto em que cada chave de linha aponta para um objeto de colunas. As chaves são os key de rows e columns, não os rótulos. Uma string JSON desse objeto também é aceita. Ver Campo matriz.
Célula vazia (null, "" ou []) sai do objeto antes de gravar. Linha que fica sem células também sai. Matriz inteira vazia vira null. O valor de cada célula segue o type da coluna: Chave de linha ou de coluna que não existe no campo é recusada. Na leitura, o mesmo campo também devolve answer_markdown: uma tabela com os rótulos das linhas e das colunas.

Datas e horas

O formulário usa o valor nativo do input. Não há máscara brasileira na gravação.

Data

date. AAAA-MM-DD.

Data e hora

date_and_time. AAAA-MM-DDTHH:mm.

Hora

time. HH:mm.

Contato e identificação

E-mail

email. String com formato de e-mail.

Telefone

phone. O formulário grava E.164, com + e código do país. A API aceita qualquer número interpretável — com +, ou nacional do Brasil sem + — e converte para E.164 antes de gravar.
Texto preenchido que não é um telefone é recusado. link. Array de URLs absolutas. Uma string JSON desse array também é aceita. Uma URL sozinha, fora do array, é recusada — no campo e na célula de uma coluna link.
Com is_multiple desligado, envie um array com um item. Com is_multiple: true, o array pode ter vários.

Registros da plataforma

O id é o identificador do registro na API. name é o nome exibido. A resposta é sempre uma lista de objetos. Estes quatro tipos não funcionam em publicação de formulário. Ver Os tipos de campo.

Usuário

user.

Contato

contact.

Cliente

customer.

Projeto

project.

Arquivos

Anexo(s)

attachment. Array de objetos de arquivo. O arquivo sobe antes, em outro endpoint; o objeto devolvido é o item da lista. O passo a passo está em Anexos em resposta de formulário.
Mais de um arquivo no mesmo campo exige is_multiple: true na definição dele.