Skip to main content
POST
/
api
/
v2
/
minikit
/
send-notification
Send Notification
curl --request POST \
  --url https://developer.world.org/api/v2/minikit/send-notification \
  --header 'Content-Type: application/json' \
  --data '
{
  "app_id": "app_id",
  "wallet_addresses": [
    "0x123",
    "0x456"
  ],
  "title": "title",
  "message": "Hello ${username}, your transaction is complete!",
  "mini_app_path": "mini_app_path"
}
'
{
  "success": true,
  "status": 123,
  "result": [
    {
      "walletAddress": "<string>",
      "sent": true,
      "reason": "<string>"
    }
  ]
}

Body

application/json

Supports legacy payload (title + message) and localized payload (localisations). If both are provided, localized payload is used.

​
wallet_addresses
string[]
required

Array of wallet addresses to notify. Users must have opted in. Max 1000 per call.

​
title
string
required
Maximum string length: 30
​
message
string
required
Maximum string length: 200
​
mini_app_path
string
required
​
app_id
string
required

Response

200 - application/json

Notification send status

​
success
boolean
​
status
integer
​
result
object[]