Notificações

Use esta página para definir se os clientes criados pela sua integração receberão notificações padrão do Asaas ou notificações personalizadas.

Quando usar cada configuração

Use notificationDisabled quando sua aplicação precisar controlar as comunicações enviadas ao cliente final. Essa configuração é útil quando você quer impedir o envio automático de notificações padrão do Asaas ou quando pretende configurar notificações específicas antes de emitir cobranças.

Escolha uma das abordagens:

• Desabilitar notificações padrão: envie notificationDisabled como true no cadastro ou na atualização do cliente.
• Personalizar notificações: mantenha as notificações habilitadas, recupere as notificações do cliente e atualize os eventos ou canais necessários.

Pré-requisitos

1. Defina se o cliente deve receber notificações padrão do Asaas ou notificações personalizadas.
2. Cadastre o cliente pela rota Criar novo cliente ou use o cliente já existente que será atualizado.
3. Para personalização, recupere os IDs das notificações pela rota Recuperar notificações de um cliente.

Parâmetro principal

Desabilitar notificações padrão de um cliente

1. Crie o cliente com notificações desabilitadas

Para criar um cliente com as notificações padrão desabilitadas, envie notificationDisabled como true no payload.

{
  "name": "Cliente Exemplo",
  "cpfCnpj": "12345678901",
  "notificationDisabled": true
}

Resultado esperado: o cliente é criado com as notificações padrão desabilitadas.

2. Atualize um cliente existente

Se o cliente já existir, envie uma atualização com notificationDisabled como true.

{
  "notificationDisabled": true
}

Resultado esperado: após a API confirmar a atualização, o cliente passa a ficar com as notificações padrão desabilitadas.

Optional: Personalizar notificações do cliente

Use este fluxo quando você quiser manter notificações ativas, mas ajustar configurações específicas, como habilitar WhatsApp ou alterar notificações existentes.

1. Crie o cliente com as notificações habilitadas.
2. Chame a rota Recuperar notificações de um cliente para obter os IDs das notificações disponíveis para o cliente.
3. Atualize as notificações usando uma das opções:
   • Atualizar notificação existente, quando quiser alterar um ID de notificação por vez.
   • Atualizar notificações existentes em lote, quando quiser aplicar alterações em múltiplas notificações.
4. Execute essa configuração antes de emitir cobranças quando sua regra de negócio exigir que o cliente já comece com um padrão específico de comunicação.

Boas práticas

• Use sempre o tipo booleano para notificationDisabled.
• Registre o payload final enviado na criação ou atualização do cliente para facilitar auditoria e suporte.
• Antes de atualizar notificações em lote, recupere os IDs mais recentes das notificações do cliente.
• Ao atualizar uma notificação individual, envie somente o ID da notificação que será alterada.
• Considere a configuração aplicada somente depois de receber uma resposta de sucesso da API.
• Teste o fluxo completo antes de emitir cobranças para clientes em produção.

Comportamentos que exigem atenção

• Payload inválido: enviar "notificationDisabled": "true" usa string em vez de booleano e pode causar comportamento incompatível com o esperado.
• Cliente já existente: atualizar notificationDisabled altera a configuração do cliente informado; confirme que o ID usado na atualização pertence ao cliente correto.
• Personalização por ID: para personalizar notificações, use os IDs retornados na consulta de notificações do cliente. Não reutilize IDs de outro cliente.
• Atualização em lote: valide a lista de notificações antes do envio para evitar alterações indesejadas em múltiplas configurações.

Conteúdos relacionados

• Criar novo cliente
• Recuperar notificações de um cliente
• Atualizar notificação existente
• Atualizar notificações existentes em lote