entity > user > notification-policy

Get All

Retrieve all notification policies associated with this entity user

get/entity/{entityId}/user/{userId}/notification-policies

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/entity/{entityId}/user/{userId}/notification-policies
  • Auth: HTTP bearer

Path parameters

entityIdstring required

Entity ID or Entity ForeignID

userIdstring required

User ID or User ForeignID

Response

Response with status 200

disabledboolean required

True if the selected notification type is disabled for this user

digestboolean required

True if the selected notification type is sent as a digest.

immediateboolean required

True if the selected notification type is sent immediately.

type'INVOICE_APPROVAL_NEEDED' | 'INVOICE_APPROVED' | 'INVOICE_REJECTED' | 'INVOICE_SCHEDULED' | 'INVOICE_PENDING' | 'INVOICE_PAID' | 'INVOICE_CANCELED' | 'INVOICE_CREATED' | 'INVOICE_EMAILED' | 'INVOICE_FAILED' | 'COUNTERPARTY_ONBOARDING_COMPLETED' required

Changes

No recorded changes to this operation across all 1 revision of this API.