Zum Inhalt springen
memberfy
de-ch

Atualiza communities

PUT/api/communities/{id}

Auth
Token erforderlich
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

Sujeito a verificação de papel (RBAC) na comunidade do X-CommunityId. O `{id}` do caminho precisa ser essa mesma comunidade; um id diferente responde 403 (SEC-15).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring (uuid)

Header

NameTypBeschreibung
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

NameTypBeschreibung
nameoptionalstring
descriptionoptionalstring
domainoptionalstring
googleAnalyticsIdoptionalstring
logoUrloptionalstring
faviconUrloptionalstring
ogImageUrloptionalstring
metaTitleoptionalstring
metaDescriptionoptionalstring
metaKeywordsoptionalstring
themeColoroptionalstringCor da barra de endereço em dispositivos móveis (PWA).
themePaletteoptionalobjectPaleta de cores da interface. Cada escala aceita os tons 50 a 950 em hexadecimal; o tom 500 é obrigatório e os tons omitidos são derivados dele. `null` restaura a paleta padrão do produto.
themePalette.primaryoptionalobjectEscala de cor da comunidade. O tom 500 é a cor base e é obrigatório; os tons omitidos são derivados dele.
themePalette.primary.50optionalstring
themePalette.primary.100optionalstring
themePalette.primary.200optionalstring
themePalette.primary.300optionalstring
themePalette.primary.400optionalstring
themePalette.primary.500Pflichtstring
themePalette.primary.600optionalstring
themePalette.primary.700optionalstring
themePalette.primary.800optionalstring
themePalette.primary.900optionalstring
themePalette.primary.950optionalstring
themePalette.secondaryoptionalobjectEscala de cor da comunidade. O tom 500 é a cor base e é obrigatório; os tons omitidos são derivados dele.
themePalette.secondary.50optionalstring
themePalette.secondary.100optionalstring
themePalette.secondary.200optionalstring
themePalette.secondary.300optionalstring
themePalette.secondary.400optionalstring
themePalette.secondary.500Pflichtstring
themePalette.secondary.600optionalstring
themePalette.secondary.700optionalstring
themePalette.secondary.800optionalstring
themePalette.secondary.900optionalstring
themePalette.secondary.950optionalstring
activeoptionalboolean
signupEnabledoptionalboolean
signupModeloptionalFREE | PAID
guestAccessoptionalboolean
contentModerationoptionalboolean
payoutEnabledoptionalboolean
globalRankingoptionalboolean
languageoptionalen-US | pt-BR | pt-PT | es-ES | es-MX | es-AR | it-IT | de-DE | de-AT | de-CHIdioma padrão da comunidade: o dos e-mails e o de quem ainda não escolheu um idioma. Só as variantes regionais; um valor fora da lista responde 400.

Antworten

StatusBeschreibung
200Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

curl-Beispiel

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