Edita um campo customizado
PATCH/api/member-fields/{id}
- Auth
- Token erforderlich
- X-CommunityId
X-CommunityIdSende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.
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.
Parameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | path | string (uuid) |
Header
| Name | Typ | Beschreibung |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request-Body application/json
| Name | Typ | Beschreibung |
|---|---|---|
labeloptional | string | max 120 |
typeoptional | TEXT | NUMBER | DATE | SELECT | BOOLEAN | |
optionsoptional | object[] | |
requiredoptional | boolean | |
orderoptional | integer | ≥ 0 |
Antworten
| Status | Beschreibung |
|---|---|
200 | Campo atualizado. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
500 | Erro interno do servidor. |
curl-Beispiel
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 '{}'