Remove um membro
DELETE/api/members/{id}
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- SuperAdmin
- Clé d’API:
- members:delete
- X-CommunityId
X-CommunityIdEnvoyez 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.
Proteção do owner: só outro owner ou um SuperAdmin remove o perfil de um owner. Admin recebe 403 `profile.ownerProtected`. Um id de outra comunidade recebe o mesmo 404 de um id que não existe. Na remoção pela equipe, `reason` (opcional, até 500 caracteres; acima, 400 com `errors[0].param = "reason"`) fica só nos Logs (`GET /api/logs`, tipo `team`, ação `member.removed`, em `details.after.reason` e no resumo), que só owner e admin leem. Nunca vai ao membro removido (nenhum e-mail ou tela) nem ao webhook `member.left`. Quem sai por conta própria não tem motivo: o campo é ignorado.
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 |
|---|---|---|
reasonfacultatif | string | max 500 |
Réponses
| Statut | Description |
|---|---|
200 | Operação realizada com sucesso. |
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`). |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
Exemple curl
curl -X DELETE "https://api.memberfy.net/api/members/<id>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'