POST
/
api
/
notifications
Create a notification
curl --request POST \
  --url http://localhost:3000/api/notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient": "<string>",
  "type": "<string>",
  "title": "<string>",
  "message": "<string>",
  "referenceId": "<string>",
  "referenceType": "<string>",
  "readStatus": true
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "_id": "<string>",
    "recipient": "<string>",
    "type": "<string>",
    "title": "<string>",
    "message": "<string>",
    "referenceId": "<string>",
    "referenceType": "<string>",
    "readStatus": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
recipient
string
required
Minimum string length: 1
​
type
string
required
Minimum string length: 1
​
title
string
required
Minimum string length: 1
​
message
string
​
referenceId
string
Minimum string length: 1
​
referenceType
string
Minimum string length: 1
​
priority
enum<string>
Available options:
low,
medium,
high,
urgent
​
readStatus
boolean

Response

Notification created

​
success
boolean
Example:

true

​
message
string
​
data
object