---
title: "Notification Preferences"
description: "Read and update the authenticated user notification preferences."
canonical: https://developer.billabex.com/en/guides/notification-preferences/
lang: en
alternate: https://developer.billabex.com/fr/guides/preferences-de-notification/
last-updated: 2026-10-26
---

# Notification Preferences

> Read and update the authenticated user notification preferences.

Source: https://developer.billabex.com/en/guides/notification-preferences/
Language: English (en)
French version: https://developer.billabex.com/fr/guides/preferences-de-notification/

Notification preferences belong to the authenticated user and apply across all their organizations.
Both endpoints require the OAuth `profile` scope.

## Read preferences

```http
GET /api/public/v1/users/me/notification-preferences
Authorization: Bearer ACCESS_TOKEN
```

```json
{
  "digestFrequency": "Weekly",
  "newsletter": true,
  "lowCreditBalanceAlerts": true
}
```

`digestFrequency` accepts `Daily`, `Weekly`, `Biweekly`, `Monthly`, or `Never`. Existing users who
have not changed their preferences use `Daily`, and newsletter subscription defaults to `true`.

## Update preferences

The update is partial. Omitted fields keep their current value.

```http
PATCH /api/public/v1/users/me/notification-preferences
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
  "digestFrequency": "Monthly",
  "newsletter": false,
  "lowCreditBalanceAlerts": false
}
```

Unknown fields, invalid frequencies, and non-boolean `newsletter` values return `400 Bad Request`.


`lowCreditBalanceAlerts` is a boolean enabled by default. It controls alerts below 12 credits
for every previously topped-up organization the user administers. An initial alert is followed
by a weekly reminder while the balance stays low. The daily check keeps at least seven days
between emails for the same top-up and administrator, without catching up missed weeks.
A new actual top-up rearms the initial alert.

This field can be updated independently of the digest and newsletter. An omitted field keeps
its current value. Alert emails include a link to My account > Notifications. Other members'
addresses and preferences are not exposed.

---

Billabex developer portal. OpenAPI specification: https://developer.billabex.com/openapi.json.
Agent instructions: https://developer.billabex.com/llms.txt. Complete documentation: https://developer.billabex.com/llms-full.txt.