Liga, desliga o chat ou escolhe quem pode iniciar conversa
PATCH/api/chat/settings
- Auth
- Requires a token
- API key:
- No API key accepted
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
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
| Name | Type | Description |
|---|---|---|
If-Unmodified-Sinceoptional | 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-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
enabledoptional | boolean | |
whoCanStartoptional | EVERYONE | PAID_MEMBERS | TEAM | |
startModeoptional | FREE | CONNECTION |
Responses
| Status | Description |
|---|---|
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. |
curl example
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 '{}'