Aller au contenu

Atualiza um membro

PUT/api/members/{id}

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
moderator
finance
SuperAdmin
Clé d’API:
members:write
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

A própria pessoa edita o seu perfil; owner e admin da comunidade do perfil editam o de qualquer membro. Proteção do owner: só outro owner ou um SuperAdmin edita o perfil de um owner. Admin recebe 403 `profile.ownerProtected`. Só os campos enviados mudam; `jobTitle` `null` ou `""` limpa o cargo. **Nome (um só por pessoa):** `name` (ou `displayName`, o nome antigo do campo) é o nome da pessoa. No **próprio perfil**, muda o nome da conta e de todos os perfis dela que mostravam o nome antigo. No perfil **de outra pessoa**, o perfil tem de ser da comunidade do `X-CommunityId` (senão o mesmo 404 de um id que não existe) e de papel abaixo do seu (owner sobre admin e abaixo, admin sobre moderador, financeiro e membro; senão 403 `profile.nameRoleTooHigh`): se o nome da conta ainda é provisório (vazio ou a parte do e-mail antes do @) e a pessoa não está em outra comunidade, ele passa a ser o nome dela; senão muda só nesta comunidade. Mandar o nome que já aparece não muda nada. `displayName` `null` ou `""` (sem `name`) limpa o nome desta comunidade, com as mesmas regras de quem pode mudar o nome. A resposta traz `name`, o nome que aparece (o desta comunidade, ou o da conta). O campo `profileType` deixou de existir (empresa existe só como empresa); se vier, é ignorado.

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring (uuid)

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (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

NomTypeDescription
namefacultatifstringNome da pessoa (ver as regras acima). · min 1, max 100
displayNamefacultatifstringMesmo que `name` (nome antigo do campo). Se os dois vierem, vale `name`. `null` ou `""` (sem `name`) limpa o nome desta comunidade: o perfil volta a mostrar o nome da conta. · max 100
taglinefacultatifstringTagline must be less than 200 characters · max 200
jobTitlefacultatifstringCargo da pessoa nesta comunidade (até 100 caracteres). `null` ou `""` limpa. · max 100
titlefacultatifstringSinônimo de `jobTitle`. Se os dois vierem, vale `jobTitle`. · max 100

Réponses

StatutDescription
200Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token 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`).
404Recurso não encontrado.
500Erro interno do servidor.

Exemple curl

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