Pular para o conteúdo principal
POST
cURL
Use este endpoint para criar questionários simples pela API. Envie um array form_elements na ordem em que os usuários devem responder às perguntas. A Didit monta o grafo interno do questionário para você. A API aceita apenas questionários lineares simples. Não envie graph, branches, next nem regras condicionais.

Campos obrigatórios

  • title é o nome interno do questionário.
  • languages deve incluir en.
  • form_elements deve conter pelo menos uma pergunta.
  • Cada elemento do formulário precisa de um element_type e de um label traduzido.
Você também pode adicionar a um elemento do formulário uma description traduzida opcional como texto de ajuda. Ela é aceita em todos os tipos de elemento, exceto separator, e é retornada como a description do item no relatório do questionário.

Tipos de elemento

Use valores em minúsculas, como short_text, multiple_choice, email, file_upload ou date_picker. Valores de enum em maiúsculas, como SHORT_TEXT, também são aceitos. Para dropdown, single_choice e multiple_choice, adicione options. Se você omitir o value de uma opção, a Didit gera um a partir do rótulo.

Validação de campos

Adicione um objeto validation opcional a um elemento short_text, long_text ou number para exigir um formato na resposta do usuário. Isso é útil para identificadores com formatos rígidos, como identificações fiscais, documentos nacionais de identidade ou números de cartão. A validação é executada enquanto o usuário preenche o campo (o usuário não pode avançar até que ela seja aprovada) e é aplicada novamente pela API no envio.
A resposta inclui questionnaire_id. Guarde esse valor, porque você o usará como questionnaire_uuid ao adicionar o questionário a um workflow.

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Corpo

application/json

Cria um questionário linear simples. A API converte form_elements no grafo interno do questionário.

title
string
obrigatório

Nome interno do questionário.

languages
string[]
obrigatório

Idiomas incluídos em cada rótulo. Deve incluir en.

Exemplo:
form_elements
object[]
obrigatório

Perguntas na ordem exata em que os usuários devem vê-las. Ramificações e campos condicionais não são suportados.

Minimum array length: 1
description
string | null
default_language
string

Idioma padrão. Deve estar incluído em languages.

Exemplo:

"en"

is_active
boolean
padrão:true
status
enum<string>

Omita este campo para criar um questionário publicado, pronto para os fluxos.

Opções disponíveis:
draft,
published

Resposta

Questionário criado. A resposta inclui o questionnaire_id; armazene-o para referenciar este questionário em fluxos ou em futuras chamadas de atualização ou exclusão.

Detalhes completos do questionário retornados pelos endpoints GET, POST (criação) e PATCH (atualização).

questionnaire_id
string<uuid>

Identificador único do questionário. Use este id ao referenciar o questionário a partir de um fluxo ou em requisições posteriores de atualização/exclusão.

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
is_simple_questionnaire
boolean
graph
object

Estrutura de grafo com start_node e o mapa de nós.

sections
object[]

Conteúdo do questionário agrupado em seções (derivado do grafo).

questionnaire_group_id
string<uuid>

Identificador estável que agrupa todas as versões do mesmo questionário.

version
integer
status
enum<string>
Opções disponíveis:
draft,
published
published_at
string<date-time> | null
is_editable
boolean

True quando o questionário ainda pode ser editado diretamente (versões de rascunho).

Última modificação em 1 de novembro de 2026