Liga ou desliga o canal SMS e define o teto diário
PUT/api/sms/settings
- Auth
- Exige token
- Chave de API:
- campaigns:write
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
Owner e admin. Ligar (`enabled: true`) exige `dailyCap` (de 1 a 50.000 mensagens por dia), mandado agora ou já salvo; sem ele, 422 com `param = dailyCap`. Ligar num plano sem SMS (`sms.messagesPerMonth` = 0) dá 409 `sms.channelNotOnPlan`. `personDailyCap` (1 a 20, padrão 5) limita as mensagens de fluxo por pessoa por dia em cada canal (SMS e WhatsApp). Campos omitidos ficam como estão. Desligar para os envios ainda na fila (são pulados com `smsChannelDisabled`).
Headers
| Nome | Tipo | Descrição |
|---|---|---|
If-Unmodified-Sinceopcional | string | Opcional: a versão lida (`updatedAt` de `GET /api/sms/settings` (a mesma versão das configurações de WhatsApp)), 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. |
Corpo da requisição application/json
| Nome | Tipo | Descrição |
|---|---|---|
enabledopcional | boolean | |
dailyCapopcional | integer | ≥ 1, ≤ 50000 |
personDailyCapopcional | integer | ≥ 1, ≤ 20 |
Respostas
| Código | Descrição |
|---|---|
200 | Configuração resultante. |
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 | Plano sem SMS (`sms.channelNotOnPlan`). |
422 | Ligar sem teto diário, ou `personDailyCap` fora de 1 a 20. |
Exemplo com curl
curl -X PUT "https://api.memberfy.net/api/sms/settings" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'