Skip to main content
POST
Send Notification

Authorizations

Authorization
string
header
required

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

Body

application/json

Supports legacy payload (title + message) and localized payload (localisations). If localisations is present, the localized payload is used and title/message are ignored.

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

Deeplink to open when the user taps the notification: a WorldApp/World ID mini app deeplink (worldapp://mini-app?app_id=... or worldid://mini-app?app_id=..., where app_id must match the request's app_id), a Deep Face Universal Link (https://world.org/verify?t=deepface), or a Deep Face deeplink (worldapp://verify?t=deepface, worldid://verify?t=deepface, worldidstg://verify?t=deepface).

app_id
string
required

Response

Notification send status

success
boolean
status
integer
result
object[]