Cria ou executa invite
POST/api/profiles/invite
- Auth
- Requiere token
- Quién puede:
- owner
- admin
- X-CommunityId
X-CommunityIdEnví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 podem dar qualquer papel atribuível, admin inclusive (a mesma regra da promoção). Owner nunca é dado na entrada; moderator e abaixo recebem 403. Cada convidado recebe e-mail, também em lote, pela fila (a resposta não espera o envio): conta nova recebe 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`); quem já tem conta recebe "você foi adicionado(a) à comunidade" com o link de entrada. Nenhuma senha é gerada nem devolvida.
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (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
| Nombre | Tipo | Descripción |
|---|---|---|
communityIdobligatorio | string (uuid) | Valid community ID is required |
emailsobligatorio | string | |
roleobligatorio | admin | moderator | member | finance | Valid role is required |
Respuestas
| Código | Descripción |
|---|---|
201 | Operação realizada com sucesso. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X POST "https://api.memberfy.net/api/profiles/invite" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"communityId":"00000000-0000-0000-0000-000000000000","emails":"string","role":"admin"}'