Skip to main content
POST
/
api
/
v2
/
minikit
/
send-notification
Send Notification
curl --request POST \
  --url https://developer.worldcoin.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
​
wallet_addresses
string[]
required

The wallet_addresses is an array of wallet addresses to send the notification to. Users must have opted in to notifications for your app. Max 1000 users per call.

​
title
string
required

The title is the title of the notification. It should be 30 characters or less. May contain emojis.

Maximum length: 30
​
message
string
required

The message is the message of the notification. It should be 200 characters or less. You can include the special variable ${username} in your message, which will be replaced with the actual username of the recipient when the notification is delivered.

Maximum length: 200
​
mini_app_path
string
required

The mini_app_path is the url encoded path of the mini app where your notification should link to when the user clicks on it. Should be of the format worldapp://mini-app?app_id=[app_id]&path=[path] (path is optional).

​
app_id
string
required

The app_id is the identifier of the app initiating the transaction.

Response

200 - application/json

Notification send status

​
success
boolean
​
status
integer
​
result
object[]