Send custom notification to a user

POST

/api/v1/notifications/custom

notifications

Last modified:2026-06-04 22:55:16

Send a targeted notification to a specific user via Firebase. Admin only.

Request: Bearer token (admin)

Body: user_key, title, body, optional image_url

Success: 200 - returns { success, message } only (no data).

Errors: 401 - invalid token | 403 - not an admin | 404 - target user not found | 422 - missing fields

Request

Body Params application/jsonRequired

Example

{
    "body": "Check what the stars say for you today.",
    "event_name": "daily_horoscope",
    "interval_name": "Every 12 hours",
    "metadata": {
        "event": "daily_horoscope"
    },
    "title": "Your daily horoscope is ready",
    "user_name": "Test user"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api/v1/notifications/custom' \
--header 'Content-Type: application/json' \
--data '{
    "body": "Check what the stars say for you today.",
    "event_name": "daily_horoscope",
    "interval_name": "Every 12 hours",
    "metadata": {
        "event": "daily_horoscope"
    },
    "title": "Your daily horoscope is ready",
    "user_name": "Test user"
}'

Responses

🟢200OK

application/json

Successful Response

Bodyapplication/json

Example

{
    "success": true,
    "message": "Notification sent"
}

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

Modified at 2026-06-04 22:55:16

Send broadcast notification

Fetch user notifications