Push Notification Service

List all sent push notifications

{
  "data": [
    {
      "id": "notif-0055",
      "user_id": "mentor-42",
      "title": "Certification expiring soon",
      "body": "Your Peer Mentor Level 2 certification expires in 14 days. Please renew.",
      "status": "delivered",
      "sent_at": "2026-03-26T08:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 234
  }
}

Get a single push notification record

{
  "id": "notif-0055",
  "user_id": "mentor-42",
  "title": "Certification expiring soon",
  "body": "Your Peer Mentor Level 2 certification expires in 14 days. Please renew.",
  "data": {
    "screen": "certifications",
    "mentor_id": "mentor-42"
  },
  "platform": "ios",
  "device_token": "abc123devicetoken",
  "status": "delivered",
  "sent_at": "2026-03-26T08:00:00Z",
  "opened_at": "2026-03-26T08:12:00Z"
}

Send a push notification to a single user (maps to sendPushNotification)

{
  "user_id": "mentor-42",
  "title": "Certification expiring soon",
  "body": "Your Peer Mentor Level 2 certification expires in 14 days. Please renew.",
  "data": {
    "screen": "certifications",
    "mentor_id": "mentor-42"
  }
}

{
  "id": "notif-0056",
  "user_id": "mentor-42",
  "title": "Certification expiring soon",
  "body": "Your Peer Mentor Level 2 certification expires in 14 days. Please renew.",
  "data": {
    "screen": "certifications",
    "mentor_id": "mentor-42"
  },
  "status": "delivered",
  "sent_at": "2026-03-26T10:00:00Z"
}

Update notification record status (e.g. mark opened)

{
  "status": "opened",
  "opened_at": "2026-03-26T10:15:00Z"
}

{
  "id": "notif-0055",
  "status": "opened",
  "opened_at": "2026-03-26T10:15:00Z",
  "updated_at": "2026-03-26T10:15:00Z"
}

Delete a notification record

{
  "deleted": true,
  "id": "notif-0055"
}

Send push notifications to multiple users (maps to sendBatchNotifications)

{
  "user_ids": [
    "mentor-19",
    "mentor-55",
    "mentor-78"
  ],
  "payload": {
    "title": "Certification renewal reminder",
    "body": "Your certification is expiring soon. Please take action.",
    "data": {
      "screen": "certifications"
    }
  }
}

{
  "batch_id": "batch-0012",
  "total": 3,
  "delivered": 3,
  "failed": 0,
  "sent_at": "2026-03-26T10:00:00Z"
}

Register a device token for a user (maps to registerDeviceToken)

{
  "user_id": "mentor-42",
  "token": "ExponentPushToken[xxxxxx]",
  "platform": "ios"
}

{
  "id": "dtoken-0034",
  "user_id": "mentor-42",
  "token": "ExponentPushToken[xxxxxx]",
  "platform": "ios",
  "registered_at": "2026-03-26T10:00:00Z"
}

Remove a device token for a user (maps to removeDeviceToken)

{
  "deleted": true,
  "token": "ExponentPushToken[xxxxxx]",
  "user_id": "mentor-42"
}

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}