| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Cria um novo registro em um Database da plataforma utilizando um modelo de formulário (modelId).
Este endpoint permite realizar inserções de dados em Databases da Goalfy através do envio estruturado de campos e valores no payload da requisição.
É recomendado para integrações que necessitam cadastrar registros automaticamente em Databases, preencher formulários dinamicamente ou sincronizar informações entre sistemas externos.
Os dados enviados serão vinculados ao formulário e ao Database informado na requisição.
Importante
AtençãoTodos os campos enviados devem possuir um
fieldInfoIdválido correspondente ao formulário relacionado ao Database.Antes de criar registros, recomenda-se consultar:
- Os modelos do formulário
- Os campos disponíveis
- Os respectivos identificadores
(fieldInfoId)
Campos utilizados no payload
| Campo | Tipo | Descrição |
|---|---|---|
modelId | string | Identificador do modelo de formulário utilizado na criação do registro. |
fields | array | Lista de campos que serão preenchidos no registro. |
value | string | array | Valor que será atribuído ao campo informado. |
fieldInfoId | string | Identificador único do campo do Formulário. |
name | string | Nome opcional do campo enviado. |
databaseID | string | Identificador único do Database onde o registro será criado. |
Body da requisição
Exemplo de body raw
{
"modelId":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"fields":[
{
"value":"Goalfy",
"fieldInfoId":"11111111-2222-3333-4444-555555555555"
},
{
"value":[
"Goalfy",
"Goalfy"
],
"fieldInfoId":"66666666-7777-8888-9999-000000000000",
"name":"Database Conectado"
}
],
"dataBaseId":"99999999-aaaa-bbbb-cccc-dddddddddddd"
}Exemplo de resposta
{
"success": true,
"message": "Registro criado com sucesso.",
"id": "12345"
}
Respostas esperadas
Sucesso 200Cria um novo registro no Database informado com os dados enviados no payload.
Possíveis erros
400 Bad RequestRetornado quando o payload enviado está inválido ou algum campo obrigatório não foi informado corretamente.
404 Not FoundRetornado quando o modelId, dataBaseId ou fieldInfoId informado não existe ou não foi localizado.
401 UnauthorizedRetornado quando o token de autenticação é inválido ou não foi enviado corretamente.
403 ForbiddenRetornado quando o usuário não possui permissão para criar registros no Database informado.
Observações
ImportanteAlguns campos podem exigir formatos específicos dependendo da configuração do formulário.
- O
modelIddeve corresponder a um formulário válido.- O
dataBaseIddeve pertencer ao Database relacionado ao formulário utilizado.- O
fieldInfoIddeve existir dentro da estrutura do formulário informado.- Campos do tipo relacionamento podem exigir arrays no campo
value.- Dependendo da configuração do formulário, determinados campos podem ser obrigatórios.
- Recomenda-se validar os dados antes de realizar integrações em ambiente de produção.
FAQ?
Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas: