Saltar al contenido

Edita um campo customizado

PATCH/api/member-fields/{id}

Auth
Requiere token
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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.

Parámetros

NombreDóndeTipoDescripción
idobligatoriopathstring (uuid)

Headers

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

Cuerpo de la solicitud application/json

NombreTipoDescripción
labelopcionalstringmax 120
typeopcionalTEXT | NUMBER | DATE | SELECT | BOOLEAN
optionsopcionalobject[]
requiredopcionalboolean
orderopcionalinteger≥ 0

Respuestas

CódigoDescripción
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.

Ejemplo 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 '{}'