Pela API do Asaas, você pode desativar todas as notificações de cobrança de um cliente (pagador) ou personalizar quais avisos são enviados, por quais canais e em qual momento. As notificações são criadas automaticamente pelo Asaas no cadastro do cliente e cada cliente possui as suas próprias configurações.
Como desativar todas as notificações de um cliente:
Utilize o campo notificationDisabled no cadastro ou na atualização do cliente:
- Na criação do cliente: envie
notificationDisabled: trueemPOST /v3/customers. - Em um cliente já cadastrado: envie
notificationDisabled: trueemPUT /v3/customers/{id}. - Para reativar: envie
notificationDisabled: falsena atualização do cliente.
Essa opção é uma desativação geral: nenhuma notificação de cobrança é enviada ao cliente, sem exceções. Se você quiser manter alguns envios, não utilize esse campo e personalize as notificações conforme o passo a passo abaixo.
Passo a passo para personalizar as notificações de um cliente:
1. Cadastre o cliente com as notificações habilitadas (padrão) e guarde o ID dele, no formato cus_....
2. Consulte as notificações do cliente em GET /v3/customers/{id}/notifications para obter o ID de cada notificação, no formato not_....
3. Para alterar uma única notificação, envie apenas os campos que deseja modificar em PUT /v3/notifications/{id}, usando o ID da notificação.
4. Para alterar várias notificações de uma só vez, utilize PUT /v3/notifications/batch, informando o ID do cliente no campo customer e a lista de notificações que serão alteradas no campo notifications.
5. Consulte novamente as notificações do cliente para confirmar que as configurações foram salvas.
Campos disponíveis para configuração:
- enabled: ativa ou desativa a notificação. Quando
false, nada é enviado, mesmo que algum canal esteja habilitado. - emailEnabledForCustomer, smsEnabledForCustomer, whatsappEnabledForCustomer e phoneCallEnabledForCustomer: definem os canais de envio para o seu cliente (e-mail, SMS, WhatsApp e robô de voz).
- emailEnabledForProvider e smsEnabledForProvider: definem se você também recebe a notificação por e-mail ou SMS.
- scheduleOffset: define o momento do envio. Para o aviso de vencimento (
PAYMENT_DUEDATE_WARNING), aceita 0, 5, 10, 15 ou 30 dias antes do vencimento. Para o aviso de atraso (PAYMENT_OVERDUE), aceita 1, 7, 15 ou 30 dias após o vencimento.
Pontos de atenção:
- Não é possível criar ou excluir notificações: pela API, você só altera as notificações que o Asaas já criou para o cliente.
- As alterações valem para os próximos envios: notificações já enviadas não são reenviadas.
- Mais de uma notificação para o mesmo evento: um cliente pode ter mais de uma notificação para o mesmo evento. Nesses casos, use o
scheduleOffsetpara identificar a notificação correta. - Cadastros feitos via API: se o cliente foi cadastrado com
notificationDisabled: true, o cadastro dele exibe o aviso de notificações desabilitadas, mesmo que os canais apareçam marcados. Nesse caso, faça a reativação também pela API, enviandonotificationDisabled: false, para manter a integração e o cadastro alinhados. - Link de pagamento: a cada pagamento por link, um novo cliente é criado, por isso as configurações anteriores não se aplicam. Para não enviar notificações nas cobranças geradas por um link, informe
notificationEnabled: falsena criação ou atualização do link. Se o campo não for enviado, o padrão étrue. - Custos: o envio de notificações pode gerar taxas. Consulte os valores em Minha conta > Taxas.
Para acessar a documentação completa, consulte os links a seguir:
Introdução às notificações: https://docs.asaas.com/docs/notificacoes
Alterando notificações de um cliente: https://docs.asaas.com/docs/alterando-notificacoes-de-um-cliente
Recuperar notificações de um cliente: https://docs.asaas.com/reference/recuperar-notificacoes-de-um-cliente
Atualizar notificações existentes em lote: https://docs.asaas.com/reference/atualizar-notificacoes-existentes-em-lote
Atualizar cliente existente: https://docs.asaas.com/reference/atualizar-cliente-existente