---
title: "Update notification preferences"
method: PATCH
path: "/api/v1/notifications/preferences"
tags: ["Notifications"]
---

# Update notification preferences

`PATCH /api/v1/notifications/preferences`

## Request

- Base URL: `http://localhost:3002`
- URL: `http://localhost:3002/api/v1/notifications/preferences`
- Auth: HTTP bearer

Merges the provided push notification preferences with the captain's existing settings.

## Request body

- NotificationPreferences
  - `push` object
    - `newBooking` boolean
    - `paymentReceived` boolean
    - `tipReceived` boolean
    - `weatherAlert` boolean
    - `bookingCancelled` boolean
    - `waiverSigned` boolean
    - `allDocumentsSigned` boolean
    - `checkoutReminder` boolean

## Response `200`

Updated preferences

- object
  - `data` NotificationPreferences, required
    - `push` object
      - `newBooking` boolean
      - `paymentReceived` boolean
      - `tipReceived` boolean
      - `weatherAlert` boolean
      - `bookingCancelled` boolean
      - `waiverSigned` boolean
      - `allDocumentsSigned` boolean
      - `checkoutReminder` boolean

## Other responses

- `400`: Request body or query parameters failed validation.
- `401`: Authentication required, or the bearer token is missing or invalid.

---

[API](https://skmtc.dev/chartercaptain/apis/charter-captain-api.md) · [All operations](https://skmtc.dev/chartercaptain/apis/charter-captain-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chartercaptain/apis/charter-captain-api/revisions/1ffea1113adb?raw)