Saltar al contenido

Atualiza communities

PUT/api/communities/{id}

Auth
Requiere token
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.

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

Parámetros

NombreDóndeTipoDescripción
idobligatoriopathstring (uuid)

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
nameopcionalstring
descriptionopcionalstring
domainopcionalstring
googleAnalyticsIdopcionalstring
logoUrlopcionalstring
faviconUrlopcionalstring
ogImageUrlopcionalstring
metaTitleopcionalstring
metaDescriptionopcionalstring
metaKeywordsopcionalstring
themeColoropcionalstringCor da barra de endereço em dispositivos móveis (PWA).
themePaletteopcionalobjectPaleta 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.primaryopcionalobjectEscala de cor da comunidade. O tom 500 é a cor base e é obrigatório; os tons omitidos são derivados dele.
themePalette.primary.50opcionalstring
themePalette.primary.100opcionalstring
themePalette.primary.200opcionalstring
themePalette.primary.300opcionalstring
themePalette.primary.400opcionalstring
themePalette.primary.500obligatoriostring
themePalette.primary.600opcionalstring
themePalette.primary.700opcionalstring
themePalette.primary.800opcionalstring
themePalette.primary.900opcionalstring
themePalette.primary.950opcionalstring
themePalette.secondaryopcionalobjectEscala de cor da comunidade. O tom 500 é a cor base e é obrigatório; os tons omitidos são derivados dele.
themePalette.secondary.50opcionalstring
themePalette.secondary.100opcionalstring
themePalette.secondary.200opcionalstring
themePalette.secondary.300opcionalstring
themePalette.secondary.400opcionalstring
themePalette.secondary.500obligatoriostring
themePalette.secondary.600opcionalstring
themePalette.secondary.700opcionalstring
themePalette.secondary.800opcionalstring
themePalette.secondary.900opcionalstring
themePalette.secondary.950opcionalstring
activeopcionalboolean
signupEnabledopcionalboolean
signupModelopcionalFREE | PAID
guestAccessopcionalboolean
contentModerationopcionalboolean
payoutEnabledopcionalboolean
globalRankingopcionalboolean
languageopcionalen-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.

Respuestas

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

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