Muda como a comunidade aparece no diretório da Memberfy
PUT/api/hub-listing
- Auth
- Requiere token
- Clave de API:
- community:write
- X-CommunityId
X-CommunityIdEnví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; moderador, financeiro e membro recebem 403. Muda só os campos enviados. Desligar `listed` remove a comunidade do hub e da busca em até 60 s no dev (o cache do site) e em até 10 minutos em produção. `category` é um código da lista (ou `null`); `coverUrl` é uma URL `https` (ou `null`), enviada antes por `POST /api/upload/community/banner`. A mudança vai para os registros da comunidade (`GET /api/logs`).
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
If-Unmodified-Sinceopcional | string | Opcional: 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-CommunityIdopcional | string (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
| Nombre | Tipo | Descripción |
|---|---|---|
listedopcional | boolean | |
categoryopcional | career | business | leadership | technology | marketing | health | education | finance | creativity | community | coworking | |
coverUrlopcional | string | max 2048 |
showMemberCountopcional | boolean |
Respuestas
| Código | Descripción |
|---|---|
200 | A configuração resultante. |
400 | Categoria fora da lista, capa que não é URL `https` ou valor que não é booleano. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
409 | Outra 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`). |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X PUT "https://api.memberfy.net/api/hub-listing" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'