Disable with notification type and channel code

Use case

Here you will find instructions on how to deactivate notifications for webhooks with notification type and channel code.

Use case data	API parameters with values
Disabling the notification type PERSON_UPDATED for channel WEBHOOK	{ "notificationTypeCode": "PERSON_UPDATED", "channelCode": "WEBHOOK" }

Sample API call

To deactivate notifications by notification type and channel code, make the API call below:

https://notification-api.sandbox.tuumplatform.com/api/v1/notification-config/disable

Disables the generation of notifications for events based on the notification type and channel code.

Learn more about the endpoint in the Tuum developer portal.

Sample request

Here is a sample request for disabling the generation of notifications for events based on the notification type and channel code:

JSON

{
  "notificationTypeCode": "PERSON_UPDATED",
  "channelCode": "WEBHOOK"
}

cURL

curl -X PUT 'https://notification-api.sandbox.tuumplatform.com/api/v1/notification-config/disable' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMjBUMTE6MjE6MjQiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODk4NTIwODR9.1v9D9oH3iGaxnQbI12MW6rhWy9vYyrmgk3aYj5AAnPQ' \
-H 'Content-Type: application/json' \
-d '{
  "notificationTypeCode": "PERSON_UPDATED",
  "channelCode": "WEBHOOK"
}'

Sample response

Below you will find the response body to the sample request:

Response

{}

Result

The API call was successful and now notifications of the type PERSON_UPDATED with ID-1114 are not generated as it is now disabled ("enabled":false).

You can validate the API call's outcome with the request: GET api/v1/notification-config