| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Realiza o preenchimento inicial de um campo em um card específico.
Este endpoint deve ser utilizado quando o campo ainda não possui valor definido ou nunca foi atualizado anteriormente.
A atualização é realizada informando o formulário, o campo desejado e o card que receberá a alteração.
Parâmetros utilizados
id
idIdentificador único do formId, para encontra-lo, precisará realizar uma request GET no Card para encontrar esse formulário.
O ID deve ser informado diretamente na rota da requisição pelo PATH.
O retorno, não retornara formId, mas aparecerá ID.
Exemplo:
POST https://api.goalfy.com.br/api/forms/12345/field/Neste exemplo:
12345
Corresponde ao ID do formId do card consultado.
Importante
- Utilize o método
POSTapenas para o primeiro preenchimento do campo.- Caso o campo já possua um valor ou tenha sido atualizado anteriormente, utilize o endpoint com método
PUTpara realizar alterações.- O campo é identificado através do
fieldInfoId.- O card que receberá a alteração é identificado através do
cardId.
fieldInfoId
fieldInfoIdIdentificador único do campo que será preenchido.
value
valueValor que será atribuído ao campo.
cardId
cardIdIdentificador do card que receberá a atualização.
Body Raw:
{
"fieldInfoId": "{{fieldInfoId}}",
"value": "Goalfy",
"cardId": "{{cardId}}"
}
Observações
- O
fieldInfoIddeve pertencer ao formulário informado na rota.- O
cardIddeve corresponder a um card válido dentro da plataforma.- Caso o campo já possua valor salvo, a requisição poderá retornar erro de validação.
- Para alterações posteriores, utilize o método
PUT.
FAQ?
Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas:
200