notifications

Create a notification

Changed on
post/notifications

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/notifications
  • Auth: none required

Request body

userIdinteger required
type'info' | 'success' | 'warning' | 'error' | 'action_required' required
channel'in_app' | 'email' | 'sms' | 'slack'
titlestring required
messagestring required
actionUrlstring

Response

Notification created

idinteger required
userIdinteger required
type'info' | 'success' | 'warning' | 'error' | 'action_required' required
channel'in_app' | 'email' | 'sms' | 'slack' required
titlestring required
messagestring required
actionUrlstring nullable
isReadboolean required
createdAtstring date-time

Changes