Skip to content

Altera o modo do tema e o logo para fundo escuro da comunidade

PATCH/api/communities/appearance

Auth
Requires a token
Who can call it:
SuperAdmin
API key:
community:write
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Owner e admin da comunidade do `X-CommunityId` (moderador, financeiro e membro recebem 403). Campo ausente fica como está; `darkLogoUrl: null` tira o logo escuro.

- `mode`: `light` (padrão), `dark` ou `auto` (segue o aparelho). `dark` e `auto` só com o tema escuro liberado pela plataforma (`darkModeAllowed`); sem isso, 422 com `param = mode`. `light` é sempre aceito. - `darkLogoUrl`: o logo para fundo escuro. Arquivo no armazenamento da Memberfy precisa ter sido enviado por esta comunidade (`POST /api/upload/community/logo` com `variant=dark`, que não troca o logo normal), como o logo normal; outro responde 400 com `param = darkLogoUrl`. Trocado ou removido, o arquivo do logo escuro anterior é apagado (nunca o logo normal). - `darkModeAllowed` não se altera aqui (400): só o SuperAdmin libera.

Cada mudança vai para o histórico da comunidade (campos `appearanceMode` e `darkLogoUrl`). Repetir o estado atual não grava nada (`changed: false`). A escolha de claro ou escuro de cada membro fica no navegador dele, não aqui.

Headers

NameTypeDescription
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request body application/json

NameTypeDescription
modeoptionallight | dark | auto
darkLogoUrloptionalstring (uri)max 2048

Responses

StatusDescription
200A aparência resultante.
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.
404Recurso não encontrado.
422Tema escuro ou automático sem a liberação da plataforma.
500Erro interno do servidor.

curl example

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