Vai al contenuto

Atualiza communities

PUT/api/communities/{id}

Auth
Richiede un token
X-CommunityId
X-CommunityId Invia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.

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).

Parametri

NomeDoveTipoDescrizione
idobbligatoriopathstring (uuid)

Header

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

Corpo della richiesta application/json

NomeTipoDescrizione
namefacoltativostring
descriptionfacoltativostring
domainfacoltativostring
googleAnalyticsIdfacoltativostring
logoUrlfacoltativostring
faviconUrlfacoltativostring
ogImageUrlfacoltativostring
metaTitlefacoltativostring
metaDescriptionfacoltativostring
metaKeywordsfacoltativostring
themeColorfacoltativostringCor da barra de endereço em dispositivos móveis (PWA).
themePalettefacoltativoobjectPaleta 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.primaryfacoltativoobjectEscala de cor da comunidade. O tom 500 é a cor base e é obrigatório; os tons omitidos são derivados dele.
themePalette.primary.50facoltativostring
themePalette.primary.100facoltativostring
themePalette.primary.200facoltativostring
themePalette.primary.300facoltativostring
themePalette.primary.400facoltativostring
themePalette.primary.500obbligatoriostring
themePalette.primary.600facoltativostring
themePalette.primary.700facoltativostring
themePalette.primary.800facoltativostring
themePalette.primary.900facoltativostring
themePalette.primary.950facoltativostring
themePalette.secondaryfacoltativoobjectEscala de cor da comunidade. O tom 500 é a cor base e é obrigatório; os tons omitidos são derivados dele.
themePalette.secondary.50facoltativostring
themePalette.secondary.100facoltativostring
themePalette.secondary.200facoltativostring
themePalette.secondary.300facoltativostring
themePalette.secondary.400facoltativostring
themePalette.secondary.500obbligatoriostring
themePalette.secondary.600facoltativostring
themePalette.secondary.700facoltativostring
themePalette.secondary.800facoltativostring
themePalette.secondary.900facoltativostring
themePalette.secondary.950facoltativostring
activefacoltativoboolean
signupEnabledfacoltativoboolean
signupModelfacoltativoFREE | PAID
guestAccessfacoltativoboolean
contentModerationfacoltativoboolean
payoutEnabledfacoltativoboolean
globalRankingfacoltativoboolean
languagefacoltativoen-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.

Risposte

CodiceDescrizione
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.

Esempio con curl

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