Liga, desliga o chat ou escolhe quem pode iniciar conversa
PATCH/api/chat/settings
- Auth
- Requiere token
- Clave de API:
- No acepta clave de API
- 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. `startMode` escolhe se conversar pede conexão (`CONNECTION`, "Precisa adicionar") ou não (`FREE`, padrão); trocar vale na hora para todas as conversas (e volta atrás sem perder nada). Desligado, o painel some e todas as outras rotas de `/api/chat` respondem 403 (os sockets abertos da comunidade recebem `chat.settings` e são fechados). As conversas ficam guardadas e voltam quando o chat é religado. A equipe não lê conversa nenhuma.
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
If-Unmodified-Sinceopcional | string | Opcional: a versão lida (`updatedAt` de `GET /api/chat/settings`), como data HTTP, se não vier `updatedAt` 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 |
|---|---|---|
enabledopcional | boolean | |
whoCanStartopcional | EVERYONE | PAID_MEMBERS | TEAM | |
startModeopcional | FREE | CONNECTION |
Respuestas
| Código | Descripción |
|---|---|
200 | Configurações atualizadas. |
400 | Requisição inválida — falha de validação. |
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 (`updatedAt` no corpo ou `If-Unmodified-Since`); `data.updatedAt` é 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 PATCH "https://api.memberfy.net/api/chat/settings" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'