Vai al contenuto

Edita um campo customizado

PATCH/api/member-fields/{id}

Auth
Richiede un token
X-CommunityId
X-CommunityId Invia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.

Owner e admin. Muda rótulo, obrigatório, ordem e opções; a `key` (e a variável) não muda. Trocar o tipo de um campo que já tem valores gravados devolve 409 (fica para a fase 2). Opção removida não apaga o valor de quem a tinha: ele continua gravado e chega em `fields[].value` sem opção correspondente.

Parametri

NomeDoveTipoDescrizione
idobbligatoriopathstring (uuid)

Header

NomeTipoDescrizione
X-CommunityIdfacoltativostring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corpo della richiesta application/json

NomeTipoDescrizione
labelfacoltativostringmax 120
typefacoltativoTEXT | NUMBER | DATE | SELECT | BOOLEAN
optionsfacoltativoobject[]
requiredfacoltativoboolean
orderfacoltativointeger≥ 0

Risposte

CodiceDescrizione
200Campo atualizado.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409Conflito com o estado atual do recurso.
500Erro interno do servidor.

Esempio con curl

curl -X PATCH "https://api.memberfy.net/api/member-fields/<id>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'