POST
/
farcaster
/
frame
/
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 '{
  "target_fids": [
    1,
    6131
  ],
  "notification": {
    "title": "Title for the notification",
    "body": "Body of the notification describing the event for the user",
    "target_url": "https://domain-of-your-frame.com/the-page-on-which-the-user-should-land",
    "uuid": "9cb07cfe-1130-48b3-a245-5dd153ced3a3"
  },
  "filters": {
    "exclude_fids": [
      2,
      8988
    ],
    "following_fid": 3,
    "minimum_user_score": 0.5,
    "near_location": {
      "latitude": 37.774929,
      "longitude": -122.419418,
      "radius": 1000
    }
  }
}'
{
  "notification_deliveries": [
    {
      "object": "notification_delivery",
      "fid": 3,
      "status": "success"
    }
  ]
}

See guide on setting this up easily here

Authorizations

x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Body

application/json

Response

200
application/json

Successful operation.

The response is of type object.