All pages
Powered by GitBook
1 of 1

Loading...

Disable with notification ID

Use case

Here you will find instructions on how to deactivate notifications for webhooks with a specific notification ID.

Use case data
API parameters with values

Disabling the notification type PERSON_UPDATED with notificationConfigId ID-1114.

Sample API call

To deactivate notifications by notification ID, make the API call below:

Disables the generation of notifications for events based on the notification ID.

Sample request

Here is a sample request for disabling the generation of notifications for events based on the notification ID:

https://notification-api.sandbox.tuumplatform.com/api/v1/notification-config/ID-1114/disable
curl -X PUT 'https://notification-api.sandbox.tuumplatform.com/api/v1/notification-config/ID-1114/disable' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMjBUMTE6MjE6MjQiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODk4NTIwODR9.1v9D9oH3iGaxnQbI12MW6rhWy9vYyrmgk3aYj5AAnPQ' \
-d ''

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).

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

Learn more about the in the Tuum developer portal.

You can validate the API call's outcome with the request:

.../notification-config/ID-1114/disable
endpoint
GET api/v1/notification-config