Sign inBook a demo
HomeGuidesAPI ReferenceGlossary
HomeGuidesAPI ReferenceGlossary
  • API Reference
Logo
Sign inBook a demo
API ReferenceEntityUserNotification Policy

Get

GET
https://api.mercoa.com/entity/:entityId/user/:userId/notification-policy/:notificationType
GET
/entity/:entityId/user/:userId/notification-policy/:notificationType
1curl 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>"
Try it
200DISABLED
1{
2  "disabled": true,
3  "digest": false,
4  "immediate": true,
5  "type": "INVOICE_APPROVED"
6}
Retrieve notification policy associated with this entity user
Was this page helpful?
Previous

Update

Next
Built with
Update
Retrieve notification policy associated with this entity user

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID
userIdstringRequired
User ID or User ForeignID
notificationTypeenumRequired

Response

This endpoint returns an object.
disabledboolean
True if the selected notification type is disabled for this user
digestboolean
True if the selected notification type is sent as a digest.
immediateboolean
True if the selected notification type is sent immediately.
typeenum

Errors

Entity ID or Entity ForeignID
User ID or User ForeignID

Bearer authentication of the form Bearer <token>, where token is your auth token.