Skip to main content
POST
/
v1
/
notifications
/
send
Send notification
curl --request POST \
  --url http://localhost:3000/v1/notifications/send \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "title": "<string>",
  "body": "<string>",
  "channels": [
    "<string>"
  ],
  "recipients": [
    "<unknown>"
  ],
  "category": "<string>",
  "priority": "<string>",
  "data": "<unknown>",
  "deepLink": "<string>",
  "imageUrl": "<string>",
  "thumbnailUrl": "<string>",
  "actionButtons": [
    {
      "action": "<string>",
      "label": "<string>"
    }
  ],
  "scheduledFor": "<string>",
  "expiresAt": "<string>",
  "groupKey": "<string>"
}
'
{
  "success": true,
  "notificationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "error": "<string>"
}

Body

application/json
type
string
required
title
string
required
body
string
required
channels
string[]
required
recipients
null[]
required
category
string
priority
string
data
unknown
imageUrl
string
thumbnailUrl
string
actionButtons
object[]
scheduledFor
string
expiresAt
string
groupKey
string

Response

200 - application/json

Send result

success
boolean
required
notificationId
string<uuid>
error
string