Edita um campo customizado
PATCH/api/member-fields/{id}
- Auth
- Jeton requis
- Clé d’API:
- members:write
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Owner e admin. Muda rótulo, obrigatório, ordem, opções e `profileVisibility` (`NEVER`, `MEMBER_CHOOSES`, `ALWAYS`, ou `null` para voltar ao automático; ver `POST /api/member-fields`); 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), com uma exceção: `SELECT` pode virar `MULTI_SELECT` mesmo com valores, e cada resposta vira uma lista de um item (as opções continuam, a não ser que venham novas, e precisam caber nas regras do `MULTI_SELECT`). O inverso devolve 409 `typeLocked`. Renomear uma opção (mesmo `value`, rótulo novo) muda o que todos que a marcaram veem. Opção removida (`SELECT` ou `MULTI_SELECT`) não apaga o valor de quem a tinha: ele continua gravado, mas some do perfil (`fields[].value`), dos filtros e das variáveis; voltar com a opção (mesmo `value`) traz o valor de volta. `pattern`/`patternMessage` só em `TEXT` (`null` ou `""` removem); trocar o tipo para outro que não `TEXT` apaga o `pattern`. Em campo obrigatório, `askOnSignup` fica `true`; desmarcar o obrigatório mantém o valor gravado.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
idobligatoire | path | string (uuid) |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corps de la requête application/json
| Nom | Type | Description |
|---|---|---|
labelfacultatif | string | max 120 |
typefacultatif | TEXT | NUMBER | DATE | SELECT | BOOLEAN | EMAIL | PHONE | URL | MULTI_SELECT | |
optionsfacultatif | object[] | |
minSelectionsfacultatif | integer | ≥ 1, ≤ 50 |
maxSelectionsfacultatif | integer | ≥ 1, ≤ 50 |
requiredfacultatif | boolean | |
askOnSignupfacultatif | boolean | |
profileVisibilityfacultatif | NEVER | MEMBER_CHOOSES | ALWAYS | Na página do membro. null = automático. |
patternfacultatif | string | max 200 |
patternMessagefacultatif | string | max 120 |
orderfacultatif | integer | ≥ 0 |
Réponses
| Statut | Description |
|---|---|
200 | Campo atualizado. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
422 | `pattern` inválido, longo demais, recusado pelo RE2 ou enviado em tipo que não é `TEXT`. |
500 | Erro interno do servidor. |
Exemple 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 '{}'