EntityUserNotification Policy

Update

POST
Update notification policy associated with this entity user

Path parameters

entityIdstringRequired
userIdstringRequired
notificationTypeenumRequired

Request

This endpoint expects an object.
disabled
booleanOptional
Set to true if the selected notification type should be disabled for this user
digest
booleanOptional
Set to true if the selected notification type should be sent as a digest. Default is false.
immediate
booleanOptional
Set to true if the selected notification type should be sent immediately. Default is true.

Response

This endpoint returns an object
disabled
boolean
True if the selected notification type is disabled for this user
digest
boolean
True if the selected notification type is sent as a digest.
immediate
boolean
True if the selected notification type is sent immediately.
type
enum
POST
1curl -X POST https://api.mercoa.com/entity/ent_8545a84e-a45f-41bf-bdf1-33b42a55812c/user/user_e24fc81c-c5ee-47e8-af42-4fe29d895506/notification-policy/INVOICE_APPROVED \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "disabled": true
6}'
200Successful
1{
2 "disabled": true,
3 "digest": false,
4 "immediate": true,
5 "type": "INVOICE_APPROVED"
6}