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,
2,
3
],
"filters": {
"exclude_fids": [
3
],
"following_fid": 3,
"minimum_user_score": 0.5,
"near_location": {
"latitude": 0,
"longitude": 0,
"address": {
"city": "<string>",
"state": "<string>",
"state_code": "<string>",
"country": "<string>",
"country_code": "<string>"
},
"radius": 1
}
},
"notification": {
"title": "New Message",
"body": "You have received a new message in your inbox.",
"target_url": "https://example.com/notifications",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
}'
{
"notification_deliveries": [
{
"object": "notification_delivery",
"fid": 3,
"status": "success",
"app_fid": 3
}
]
}
Send notifications to interactors of a mini app
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,
2,
3
],
"filters": {
"exclude_fids": [
3
],
"following_fid": 3,
"minimum_user_score": 0.5,
"near_location": {
"latitude": 0,
"longitude": 0,
"address": {
"city": "<string>",
"state": "<string>",
"state_code": "<string>",
"country": "<string>",
"country_code": "<string>"
},
"radius": 1
}
},
"notification": {
"title": "New Message",
"body": "You have received a new message in your inbox.",
"target_url": "https://example.com/notifications",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
}'
{
"notification_deliveries": [
{
"object": "notification_delivery",
"fid": 3,
"status": "success",
"app_fid": 3
}
]
}
API key to authorize requests
Success
The response is of type object
.
Was this page helpful?