Desabilitar uma configuração
stable
Ao registrar uma configuração de webhook, ela automaticamente fica habilitada. Porém, é possível desabilitá-la a qualquer momento por meio deste endpoint.
Requisição (Request)
Requisição HTTP
PATCH 'https://api-mtls.sandbox.bankly.com.br/webhooks/configurations/{id}/disable'
--request PATCH \
--url 'https://api-mtls.sandbox.bankly.com.br/webhooks/configurations/e77748a7-dcd2-4f22-9242-096420dc6fa3/disable' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'Authorization: Bearer [token]' \
Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
webhook.write | Concede acesso para criar, atualizar, habilitar e desabilitar um webhook. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path)
No path desta requisição envie os seguintes campos:
| Nome | Tipo | Descrição |
|---|---|---|
id | path | Obrigatório. id do webhook, que pode ser obtido na consulta de todas as configurações de webhooks. |
Corpo da requisição (Body)
Não é necessário enviar campos no body desta requisição.
Resposta (Response)
O status code 204 indicará sucesso ao desabilitar uma configuração.
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated about 1 month ago