Saltar al contenido

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

PATCH/api/communities/appearance

Auth
Requiere token
Quién puede:
SuperAdmin
Clave de API:
community:write
X-CommunityId
X-CommunityId Enví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 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

NombreTipoDescripción
X-CommunityIdopcionalstring (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

NombreTipoDescripción
modeopcionallight | dark | auto
darkLogoUrlopcionalstring (uri)max 2048

Respuestas

CódigoDescripción
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.

Ejemplo con curl

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 '{}'