Cria um membro na comunidade
POST/api/members
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- Clé d’API:
- members:write
- 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.
Owner e admin da comunidade do `X-CommunityId` podem dar qualquer papel atribuível, admin inclusive (a mesma regra da promoção). Owner nunca é dado na entrada; moderator e abaixo recebem 403. A pessoa recebe pela fila (a resposta não espera o envio) o link de uso único `https://<app da comunidade>/_/auth/set-password?id=&token=`, válido por 7 dias (ver `POST /api/auth/set-password`). A resposta não traz mais `tempPassword`. **Comunidade suspensa pela Memberfy**: 403 com `errors`, `code: COMMUNITY_SUSPENDED` e o motivo (em `message` e em `reason`) para owner, admin, moderador e financeiro; nada é criado nem enviado.
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 |
|---|---|---|
fullNameobligatoire | string | Full name must be between 2 and 100 characters · min 2, max 100 |
emailobligatoire | string (email) | Valid email is required |
roleobligatoire | admin | moderator | member | finance | Valid role is required |
avatarUrlfacultatif | string (uri) | Avatar URL must be a valid URL |
jobTitlefacultatif | string | Cargo da pessoa nesta comunidade (opcional, até 100 caracteres; vazio vira `null`). · max 100 |
titlefacultatif | string | Sinônimo de `jobTitle`, aceito por compatibilidade. Se os dois vierem, vale `jobTitle`. · max 100 |
Réponses
| Statut | Description |
|---|---|
201 | 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`). |
409 | O e-mail pediu para não participar da comunidade (recusou um convite); nada é criado nem enviado. |
500 | Erro interno do servidor. |
Exemple curl
curl -X POST "https://api.memberfy.net/api/members" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"fullName":"string","email":"[email protected]","role":"admin"}'