Skip to main content
POST
/
v2
/
farcaster
/
frame
/
notifications
Send notifications
curl --request POST \
  --url https://api.neynar.com/v2/farcaster/frame/notifications/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "notification": {
    "body": "You have received a new message in your inbox.",
    "target_url": "https://example.com/notifications",
    "title": "New Message",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "filters": {
    "exclude_fids": [
      2,
      8988
    ],
    "following_fid": 3,
    "minimum_user_score": 0.5,
    "near_location": {
      "latitude": 37.774929,
      "longitude": -122.419418,
      "radius": 1000
    }
  },
  "target_fids": [
    1,
    2,
    3
  ]
}
'
{
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "failure_count": 123,
  "not_attempted_count": 123,
  "success_count": 123,
  "retryable_fids": [
    3
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.neynar.com/llms.txt

Use this file to discover all available pages before exploring further.

​
See guide on setting this up easily Send Notifications to Mini App Users

​
Node.js SDK

🔗 SDK Method: publishFrameNotifications Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Body

application/json
​
notification
object
required
​
filters
object

Filters to apply to the target_fids set. All filters are additive, so only users matching all filters will be notified.

Example:
{
  "exclude_fids": [2, 8988],
  "following_fid": 3,
  "minimum_user_score": 0.5,
  "near_location": {
    "latitude": 37.774929,
    "longitude": -122.419418,
    "radius": 1000
  }
}
​
target_fids
integer[]

An array of target FIDs to whom the notifications should be sent. Each FID must be a positive integer. Pass an empty array to send notifications to all FIDs with notifications enabled for the mini app.

Maximum array length: 100
Required range: x >= 1
Example:
[1, 2, 3]

Response

Success

​
campaign_id
string<uuid>
required

The unique identifier for the notification campaign.

​
failure_count
integer<int32>
required

The number of notifications that failed to deliver.

​
not_attempted_count
integer<int32>
required

The number of notifications not attempted (e.g., disabled tokens, invalid tokens).

​
success_count
integer<int32>
required

The number of notifications successfully delivered.

​
retryable_fids
integer<int32>[]

List of FIDs that failed due to retryable errors (rate_limited, failed, http_error). Can be used to retry sending notifications to these users.

The unique identifier of a farcaster user or app (unsigned integer)

Required range: x >= 0