Aller au contenu

Envia o logo da comunidade (normal ou para fundo escuro)

POST/api/upload/community/logo

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

Owner e admin da comunidade (`communityId` no corpo). Sem `variant` (ou `regular`), o arquivo vira o logo da comunidade (`logoUrl`) e o logo anterior é apagado.

Com `variant=dark`, é o logo para fundo escuro: o arquivo é guardado no mesmo lugar dos logos da comunidade, mas **não muda o `logoUrl` nem apaga nada**; a resposta traz só `data.url`, que vai em `darkLogoUrl` de `PATCH /api/communities/appearance` (é lá que o logo escuro anterior é apagado, quando trocado ou removido). `variant` diferente de `dark` ou `regular`: 400.

En-têtes

NomTypeDescription
If-Unmodified-SincefacultatifstringOpcional: a versão lida (`settingsUpdatedAt` de `GET /api/communities/settings` ou da última gravação (uma versão só para a linha da comunidade: perfil, marca, imagens, diretório, remetentes das automações e domínio)), como data HTTP, se não vier `settingsUpdatedAt` no corpo. Outra gravação depois dela responde 409.
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 multipart/form-data

NomTypeDescription
logoobligatoirestring (binary)
communityIdobligatoirestring (uuid)
variantfacultatifregular | dark`dark`: logo para fundo escuro, sem trocar o logo da comunidade.

Réponses

StatutDescription
200Logo enviado. Com `variant=dark`, `data` traz só `url`.
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`).
409Outra gravação veio antes da versão enviada (`settingsUpdatedAt` no corpo ou `If-Unmodified-Since`); `data.settingsUpdatedAt` é a versão atual: recarregue e repita. Cada gravação avisa os editores abertos (`item.saved`, ver `POST /api/realtime/ticket`).
500Erro interno do servidor.

Exemple curl

curl -X POST "https://api.memberfy.net/api/upload/community/logo" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -F "file=@caminho/do/arquivo"