Liga ou desliga o WhatsApp e define o teto diário
PUT/api/whatsapp/settings
- Auth
- Token erforderlich
- Wer darf:
- owner
- admin
- API-Schlüssel:
- campaigns:write
- X-CommunityId
X-CommunityIdSende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.
Owner ou admin. Para ligar, `dailyCap` é obrigatório (422 sem ele). Num plano sem WhatsApp (`whatsapp.enabled`, só Business e Scale), 403 `whatsapp.notOnPlan`; com `whatsapp.messagesPerMonth` = 0, 409 `whatsapp.channelNotOnPlan`. `moments` (`{ chave: boolean }`) desliga ou religa um momento para a comunidade inteira (chave desconhecida: 422 `whatsapp.momentInvalid`).
Header
| Name | Typ | Beschreibung |
|---|---|---|
If-Unmodified-Sinceoptional | string | Opcional: a versão lida (`updatedAt` de `GET /api/whatsapp/settings` (a mesma versão das configurações de SMS)), 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 | Typ | Beschreibung |
|---|---|---|
enabledoptional | boolean | |
dailyCapoptional | integer | ≥ 1, ≤ 50000 |
momentsoptional | object |
Antworten
| Status | Beschreibung |
|---|---|
200 | Configuração salva. |
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 | Plano sem WhatsApp (`whatsapp.notOnPlan`), ou papel sem acesso. |
409 | Plano com cota 0. |
422 | Ligar sem teto diário. |
curl-Beispiel
curl -X PUT "https://api.memberfy.net/api/whatsapp/settings" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'