A notificação para evento é um serviço de disparo de notificações automáticas por e-mail e/ou SMS. O disparo é acionado no momento que ocorre a mudança da situação do boleto para as situações de Registro, Liquidação ou Baixa.
DELETE
Homologação:
https://homologacao.plugboleto.com.br/api/v1/eventos/agendamentos
Produção:
https://plugboleto.com.br/api/v1/eventos/agendamentos
Headers
Nome | Descrição | Exemplo |
Content-Type | Indica o tipo de arquivo | application/json |
cnpj-cedente | CNPJ do Cedente | 01001001000113 |
cnpj-sh | CNPJ da Software House | 01001001000113 |
token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
Headers (Opcional)
Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:
Nome | Descrição | Exemplo |
Content-Type | Indica o tipo de arquivo | application/json |
cnpj-cedente | CNPJ do Cedente | 01001001000113 |
token-cedente | Token do Cedente | f22b97c0c9a3d41ac0a3875aba69e5aa1 |
Objeto
Para deletar as notificações de evento, o objeto JSON deve ter o seguinte campo:
Campo | Tipo | Descrição |
tipos | Array<Integer> | Tipo de evento a ser deletado, 1 - Evento de registro 2 - Evento de liquidação 3 - Evento de baixa 4 - Evento de protesto |
Body
Essa rota recebe no body da requisição uma lista de tipos de notificação a serem deletadas.
Exemplo de JSON:
No exemplo logo abaixo, está sendo deletada uma notificação de liquidação.
{
"tipos": [2]
}
Retorno
Exemplo de retorno:
{
_status : 'sucesso',
_mensagem: 'Configurações de eventos deletadas com sucesso'
}
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Erro de validação.",
"_dados": [
{
"_campo": "erro",
"_erro": "A propriedade tipos é obrigatória."
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.