Skip to main content
POST
Criar formulário

Authorizations

Authorization
string
header
required

Chave de API da Arara (ara_live_...), enviada no header Authorization: Bearer ara_live_.... Crie e gerencie as chaves no painel: https://app.ararahq.com/dashboard/apikeys. O valor completo aparece uma única vez, na criação.

Body

application/json
name
string
required

Nome interno, único por número. Só você vê.

Maximum string length: 120
category
enum<string>
required
Available options:
SIGN_UP,
LEAD_GENERATION,
SURVEY,
APPOINTMENT_BOOKING,
CONTACT_US,
OTHER
title
string
required

Aparece no topo do formulário.

Maximum string length: 30
fields
object[]
required

De 1 a 10 perguntas, todas na mesma tela.

Required array length: 1 - 10 elements
intro
string | null

Texto de introdução, abaixo do título.

Maximum string length: 300
submitLabel
string
default:Enviar

Texto do botão de envio.

Maximum string length: 30

Response

Formulário criado

id
string<uuid>
required

Use como flowId no envio e no botão FLOW do template.

name
string
required
category
enum<string>
required
Available options:
SIGN_UP,
LEAD_GENERATION,
SURVEY,
APPOINTMENT_BOOKING,
CONTACT_US,
OTHER
status
enum<string>
required

DRAFT: criado, mas a publicação falhou (veja publishError). PUBLISHED: no ar, pode ser enviado. DEPRECATED: desativado.

Available options:
DRAFT,
PUBLISHED,
DEPRECATED
definition
object
required

O formulário como foi criado, já com as chaves finais.

responseCount
integer<int64>
required

Total de respostas recebidas.

publishError
string | null

Preenchido só quando o formulário foi criado mas a publicação falhou.

createdAt
string<date-time> | null
publishedAt
string<date-time> | null