put https://api.stage.cora.com.br/invoices//notifications
Edite as notificações atreladas a um boleto através desta API
Importante para Integração Direta
Para você conseguir efetuar essa integração é obrigatória a leitura sobre "Utilização das APIs" e recomendada a leitura sobre "Instruções Iniciais" e "Client Credentials e Client ID"
Quais são os requisitos para a utilização desta API?
- Token: possuir um token de acesso válido é essencial. Caso ainda não tenha gerado um, temos um guia detalhado disponível no tópico Fluxos de Autorização e Autenticação.
- Boleto: para que a resposta da API seja preenchida, é recomendável que um boleto tenha sido gerado anteriormente, o identificador desse boleto deve ser indicado no parâmetro da url.
Não há restrição de edição nos campos. Todos os campos do objeto podem ser modificados.
Parâmetros da requisição
Parâmetro | Tipo | Descrição |
---|---|---|
id_invoice obrigatório | String | Identificador do boleto que deve ser indicado no próprio endpoint |
channels obrigatório | String | Array de Strings que representam os canais de comunicação escolhidos. Hoje aceita apenas o canal "EMAIL" |
destination obrigatório | Object | Objeto InvoiceDestination |
rules obrigatório | String | String que representa a regras das notificação. As possíveis Strings estão detalhadas no Enum de Tipos de Notificação |
Integração Direta e Testes
Esta plataforma de documentação, atualmente, não permite o upload de informações importantes como certificados e private keys. Por isso, não recomendamos o uso dela para testes da modalidade de Integração Direta. Para fazer os testes que incluam essas informações sensíveis pedimos que use um sistema de sua escolha.
Agora é hora do Café!
Sim, aprendemos a atualizar notificações do boleto