Alterar Subscrição

Este endpoint é utilizado para alterar uma subscrição existente.

Requisição

PATCH https://api-sandbox.catalisa.com.br/webhooks/api/v1/subscriptions

Escopos JWT: webhooks-engine/manage:subscriptions webhooks-engine/update:subscriptions

DICA

Por se tratar de um método PATCH, apenas os campos que forem enviados no corpo da requisição serão alterados. Os demais campos permanecerão inalterados.

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Content-Type	application/json

Respostas

Código	Descrição
200	Sucesso ao alterar. Retorna a subscrição alterada.
401	Não autorizado
404	Subscrição não encontrada

Campos que podem ser alterados

Nome	Tipo	Descrição
name	string	Nome da subscrição.
targetUrl	string	URL para onde as notificações serão enviadas.
state	string	Estado da subscrição. Pode ser active ou inactive. O padrão é active

Exemplos de uso

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Content-Type", "application/json");

const body = JSON.stringify({
  data: {
    type: "subscriptions",
    attributes: {
      name: "Nome atualizado",
      state: "inactive",
      targetUrl: "https://exemplo.com.br/url/atualizada",
    },
  },
});

const requestOptions = {
  method: "PATCH",
  headers: headers,
  body: body,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/webhooks/api/v1/subscriptions/3a396c21-f644-4013-8e06-470d59f3f719",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request PATCH 'https://api-sandbox.catalisa.com.br/webhooks/api/v1/subscriptions/3a396c21-f644-4013-8e06-470d59f3f719' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
--data-raw '{
  data: {
    type: "subscriptions",
    attributes: {
      name: "Nome atualizado",
      state: "inactive",
      targetUrl: "https://exemplo.com.br/url/atualizada",
    },
  },
}'

Exemplo de Sucesso

{
  "data": [
    {
      "type": "subscriptions",
      "id": "3a396c21-f644-4013-8e06-470d59f3f719",
      "attributes": {
        "event": "document.status.signed",
        "name": "Nome atualizado",
        "context": "doc-signature",
        "state": "inactive",
        "targetUrl": "https://exemplo.com.br/url/atualizada"
      },
      "links": {
        "self": "https://api-sandbox.catalisa.com.br/webhooks/api/v1/subscriptions/3a396c21-f644-4013-8e06-470d59f3f719"
      }
    }
  ],
  "links": {
    "self": "https://api-sandbox.catalisa.com.br/webhooks/api/v1/subscriptions"
  }
}