Aller au contenu
memberfy
FR

Cria ou executa communities

POST/api/communities

Auth
Jeton requis
Clé d’API:
community: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.

Só SuperAdmin (sessão na comunidade da plataforma); qualquer outra pessoa logada recebe 403. Comunidades nascem pelo pedido de acesso aprovado ou por `POST /api/admin/communities/provision`. Cria a comunidade com quem chama como owner. O endereço (`domain`) não é aceito aqui: um `domain` no corpo é ignorado e a comunidade nasce sem endereço; só a configuração do endereço o grava.

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
nameobligatoirestringCommunity name is required
slugobligatoirestringSlug is required
acceptedTermsfacultatifbooleanAceite dos Termos de uso. Opcional: criar a comunidade registra o aceite na conta de quem cria (`termsAcceptedAt`, `termsVersion` em `GET /api/auth/me`), se ainda não houver um. Enviado, precisa ser `true`; `false` devolve 400 com param = acceptedTerms.
themePalettefacultatifobjectOpcional. A comunidade nasce com o tema pronto "Claro" salvo e ativo; uma paleta enviada vira as cores claras desse tema (tons omitidos derivados do 500). Paleta inválida, 400.
themePalette.primaryfacultatifobjectEscala de cor da comunidade. O tom 500 é a cor base e é obrigatório; os tons omitidos são derivados dele.
themePalette.primary.50facultatifstring
themePalette.primary.100facultatifstring
themePalette.primary.200facultatifstring
themePalette.primary.300facultatifstring
themePalette.primary.400facultatifstring
themePalette.primary.500obligatoirestring
themePalette.primary.600facultatifstring
themePalette.primary.700facultatifstring
themePalette.primary.800facultatifstring
themePalette.primary.900facultatifstring
themePalette.primary.950facultatifstring
themePalette.secondaryfacultatifobjectEscala de cor da comunidade. O tom 500 é a cor base e é obrigatório; os tons omitidos são derivados dele.
themePalette.secondary.50facultatifstring
themePalette.secondary.100facultatifstring
themePalette.secondary.200facultatifstring
themePalette.secondary.300facultatifstring
themePalette.secondary.400facultatifstring
themePalette.secondary.500obligatoirestring
themePalette.secondary.600facultatifstring
themePalette.secondary.700facultatifstring
themePalette.secondary.800facultatifstring
themePalette.secondary.900facultatifstring
themePalette.secondary.950facultatifstring
themeColorfacultatifstringOpcional: a cor da barra do navegador do tema "Claro" com que a comunidade nasce.

Réponses

StatutDescription
201Operaçã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`).
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Exemple curl

curl -X POST "https://api.memberfy.net/api/communities" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","slug":"string"}'