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"
  }
}'
{
  "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
target_fids
integer[]
required

An array of target FIDs to whom the notifications should be sent. Each FID must be a positive integer, with a maximum of 100 FIDs allowed per call.

The unique identifier of a farcaster user (unsigned integer)

Example:
[1, 2, 3]
notification
object
required

Response

200
application/json
Successful operation.
notification_deliveries
object[]
required