Skip to content
memberfy
US

Liga ou desliga o WhatsApp e define o teto diário

PUT/api/whatsapp/settings

Auth
Requires a token
Who can call it:
owner
admin
API key:
campaigns:write
X-CommunityId
X-CommunityId Send 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 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`).

Headers

NameTypeDescription
If-Unmodified-SinceoptionalstringOpcional: 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-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request body application/json

NameTypeDescription
enabledoptionalboolean
dailyCapoptionalinteger≥ 1, ≤ 50000
momentsoptionalobject

Responses

StatusDescription
200Configuração salva.
401Token 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`).
403Plano sem WhatsApp (`whatsapp.notOnPlan`), ou papel sem acesso.
409Plano com cota 0.
422Ligar sem teto diário.

curl example

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 '{}'