Criar registro de formulário
Grava um novo registro em um formulário dinâmico do CUBE.
O body deve seguir o exemploBody retornado por Consultar modelo de registro. As chaves são as chave dos campos do formulário e os valores seguem o formato de cada campo.
cuidado
- Campos
SELECTdinâmicos sem opções retornadas no modelo vêm com valornullnoexemploBody. Se forem obrigatórios, informe o valor antes de enviar. - Regras de validação configuradas no formulário são aplicadas na gravação. Caso algum valor não atenda a uma regra, a API retorna 400 com a mensagem da regra.
- Campos
INPUTFILErecebem apenas a URL/referência do arquivo (texto). Não há upload de arquivo por este endpoint.
Endpoints
| Método | URL |
|---|---|
| POST | https://{{url}}/cube/api/v3/formularios/{{idFormulario}}/registros |
Exemplo de Corpo JSON
{
"ip_nome": "Maria da Silva",
"ip_cpf": "123.456.789-00",
"dt_visita": "2026-10-20T14:30",
"ip_quantidade": 2,
"cb_aceite": 1,
"sl_tipo": "Residencial",
"up_foto": "https://meuwebsite.com/arquivos/foto.jpg"
}
| Chave | Descrição |
|---|---|
| {{chave}} | Valor do campo do formulário. As chaves, obrigatoriedade e formatos são os informados em campos no modelo de registro. |
dica
Envie apenas campos do formulário. Chaves que não pertencem ao formulário são ignoradas, e o ID do formulário é informado somente na URL.
Respostas
Exemplo de corpo da resposta
{
"idRegistro": 456
}
Exemplo de corpo da resposta em caso de erro
{
"errors": [
{
"attribute": "preenchimento.obrigatorio",
"message": "ip_nome, dt_visita"
}
]
}
O attribute traz a chave da validação que falhou e o message traz as chaves dos campos envolvidos.
Dicionário dos dados retornados na API
| Chave | Descrição |
|---|---|
| idRegistro | Numérico - ID do registro criado no formulário. |
Status da resposta
| Status | Descrição |
|---|---|
| 201 | Created - Registro gravado com sucesso. |
| 400 | Registro inválido - Campos obrigatórios não preenchidos ou regras do formulário não atendidas. |
| 401 | Credenciais de acesso inválidas ou não informadas. |
| 404 | Formulário não encontrado. |