Skip to main content
POST
/
v1
/
ui
/
notifications
/
broadcast
cURL
curl --request POST \
  --url https://api.example.com/v1/ui/notifications/broadcast \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "message": "<string>",
  "metadata": {},
  "type": "info",
  "priority": "low",
  "actionUrl": "<string>",
  "actionText": "<string>",
  "expiresAt": "<unknown>",
  "environment": "sandbox"
}
'

Body

application/json
​
title
string
required
Minimum string length: 1
​
message
string
required
Minimum string length: 1
​
metadata
object
required
​
type
enum<string>
Available options:
info,
success,
warning,
error,
payment,
transaction,
system
​
priority
enum<string>
Available options:
low,
medium,
high,
urgent
​
actionUrl
string
​
actionText
string
​
expiresAt
any
​
environment
enum<string>
Available options:
sandbox,
live

Response

201 - undefined