| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Cria um novo card utilizando um formulário como modelo de preenchimento.
Este endpoint permite criar cards de forma dinâmica através do envio dos campos configurados no formulário associado ao Board. Os valores enviados serão utilizados para preencher os respectivos campos durante a criação do card.
É recomendado para integrações que realizam cadastros automáticos, captura de leads, sincronização de dados ou criação de processos diretamente na plataforma.
modelId
modelIdLista de campos que serão preenchidos durante a criação do card.
Cada item do array representa um campo do formulário.
fields
fieldsLista de campos que serão preenchidos durante a criação do card.
Cada item do array representa um campo do formulário.
value
valueValor que será atribuído ao campo informado.
O tipo do valor pode variar conforme a configuração do campo no formulário.
fieldInfoId
fieldInfoIdIdentificador único do campo dentro do formulário.
Este identificador informa à API qual campo deverá receber o valor enviado.
O fieldInfoId pode ser obtido através dos endpoints de consulta de campos ou ao consultar informações do formulário.
Body da Requisição
{
"modelId": "{{modelID}}",
"fields": [
{
"value": "Goalfy",
"fieldInfoId": "{{infoId}}"
},
{
"value": "Goalfy",
"fieldInfoId": "{{infoId}}"
},
{
"value": "Goalfy",
"fieldInfoId": "{{infoId}}"
}
]
}
Respostas esperadas
Sucesso 200Cria um novo card utilizando o formulário informado e retorna os dados relacionados ao card criado.
O card será inserido no fluxo correspondente ao formulário utilizado e os campos enviados serão preenchidos conforme os valores informados na requisição.
Possíveis erros
400 Bad RequestRetornado quando algum campo obrigatório não foi enviado, possui formato inválido ou contém informações incompatíveis com o tipo de campo configurado.
404 Not FoundRetornado quando o modelId informado não existe ou não foi localizado.
Também pode ocorrer quando algum fieldInfoId enviado não pertence ao formulário informado.
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 cards utilizando o formulário informado.
Observações
ImportanteO comportamento da criação pode variar conforme as configurações do formulário e do Board.
- O modelId deve corresponder a um formulário válido e ativo.
- Todos os fieldInfoId enviados devem pertencer ao formulário informado.
- Campos ocultos ou desativados podem não aceitar preenchimento via API dependendo da configuração da organização.
- Alguns tipos de campo podem exigir formatos específicos de valor.
- O card será criado na fase inicial definida pelo fluxo do formulário.
- Dependendo das automações configuradas no Board, a criação do card poderá disparar ações automáticas, notificações ou integrações.
- Recomenda-se validar previamente os IDs dos campos para evitar erros de preenchimento.
FAQ?
Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas: