Cria um grupo de membros
POST/api/member-groups
- Auth
- Jeton requis
- 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.
O nome é único dentro da comunidade. `parentGroupId` permite diretoria → área → squad; um pai que fechasse o ciclo é recusado.
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 |
|---|---|---|
nameobligatoire | string | max 120 |
descriptionfacultatif | string | max 500 |
parentGroupIdfacultatif | string (uuid) | |
leaderMemberIdfacultatif | string (uuid) | |
colorfacultatif | string | Hex de 6 dígitos com # |
orderfacultatif | integer | ≥ 0 |
isDefaultfacultatif | boolean | Todo mundo entra neste grupo: ao marcar, os perfis existentes entram na hora e todo perfil novo passa a entrar junto. Desmarcar nao remove ninguem. |
Réponses
| Statut | Description |
|---|---|
201 | Grupo criado 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
409 | Conflito com o estado atual do recurso. |
500 | Erro interno do servidor. |
Exemple curl
curl -X POST "https://api.memberfy.net/api/member-groups" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'