EntityUserNotification Policy

Update

POST
https://api.mercoa.com/entity/:entityId/user/:userId/notification-policy/:notificationType

Update notification policy associated with this entity user

Path parameters

entityId
string
userId
string
notificationType
enum

Request

This endpoint expects an object.
disabled
optional boolean

Set to true if the selected notification type should be disabled for this user

digest
optional boolean

Set to true if the selected notification type should be sent as a digest. Default is false.

immediate
optional boolean

Set to true if the selected notification type should be sent immediately. Default is true.

Response

This endpoint return 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
/entity/:entityId/user/:userId/notification-policy/:notificationType
curl -X POST https://api.mercoa.com/entity/:entityId/user/:userId/notification-policy/INVOICE_APPROVAL_NEEDED \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{}'
Response
{
"disabled": true,
"digest": true,
"immediate": true,
"type": "INVOICE_APPROVAL_NEEDED"
}