| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Atualiza o valor de um campo específico de um registro já existente na plataforma.
Este endpoint permite alterar informações de registros através do identificador único do campo (fieldInfoId), possibilitando integrações para atualização dinâmica de dados em formulários e databases.
A atualização será realizada diretamente no campo informado, substituindo o valor atual pelo novo valor enviado no payload da requisição.
Importante
AtençãoUtilize o método
POSTquando o campo ainda não possuir valor preenchido.Caso o campo já tenha sido preenchido anteriormente ou já possua um valor salvo, utilize o método
PUTpara realizar a atualização.
Parâmetros utilizados
fieldInfoId
fieldInfoIdIdentificador único do campo que será atualizado.
O valor deve ser informado diretamente na rota da requisição.
Exemplo:
PUT https://api.goalfy.com.br/api/forms/field/abcd-1234-efgh-5678Neste exemplo:
abcd-1234-efgh-5678
Corresponde ao identificador do campo que será atualizado.
Body da requisição
O payload deve conter o novo valor que será atribuído ao campo.
Exemplo de Body Raw
{
"value": "Goalfy"
}Exemplo de Resposta
{
"success": true,
"message": "Campo atualizado com sucesso."
}
Possíveis erros
400 Bad RequestRetornado quando o payload enviado está inválido ou incompleto.
404 Not FoundRetornado quando o 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 atualizar o campo informado.
Observações
ImportanteA atualização substituirá completamente o valor anterior armazenado no campo.
- O fieldInfoId deve corresponder a um campo válido existente na plataforma.
- Alguns tipos de campo podem possuir validações específicas.
- Dependendo da configuração do formulário, determinados campos podem exigir formatos específicos de valor.
- Recomenda-se validar os dados antes de realizar atualizações em produção.
- O retorno da requisição pode variar conforme as permissões do usuário autenticado.
FAQ?
Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas:
200