# Update a note.

`PUT /listings/{listing_id}/notes/{note_id}`

> Wheelhouse Revenue Management API. Web version: https://docs.usewheelhouse.com/rm/reference/rm-put-note · OpenAPI spec: https://docs.usewheelhouse.com/rm/openapi.yaml · Operation ID: `rmPutNote` · Tag: Notes

Updates the given fields of a note. Fields that are not provided are left unchanged. Set `status` to `archived` to archive a note, or back to `active` to restore it.

**Note:** it is not currently possible to clear an optional field once set (for example, removing an existing date range or reminder). Omitting a field in the request body leaves the current value in place; there is no way to unset `start_date`/`end_date` or `remind_by`/`repeat_by` via this endpoint.

## Request

`PUT https://api.usewheelhouse.com/ss_api/v1/listings/{listing_id}/notes/{note_id}`

Authentication: send your RM API key in the `X-Integration-Api-Key` header (see https://docs.usewheelhouse.com/rm/authentication.md). Modifies data; read-only keys get `403 Forbidden`.

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `listing_id` | string | yes | The channel's unique listing identifier, or the Wheelhouse listing ID when `channel` is `wheelhouse`. |
| `note_id` | integer | yes | The Wheelhouse internal note ID. |

### Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `channel` | string | yes | Channel name the listing is on (the `channel` field of the [/listings](https://docs.usewheelhouse.com/rm/reference/rm-get-listings.md) response), or the literal `wheelhouse` to read `listing_id` as a Wheelhouse listing ID instead. See [Identifying Listings](https://docs.usewheelhouse.com/rm/concepts/listings.md). |

### Request body (`application/json`, required)

- `description` (string): The note text.
- `category` (array of string): The settings categories the note relates to. See the `note_response` schema for allowed values.
- `start_date` (string (date)): First stay date the note applies to (YYYY-MM-DD). Must be provided together with `end_date` and must be on or before it.
- `end_date` (string (date)): Last stay date the note applies to (YYYY-MM-DD). Must be provided together with `start_date`.
- `remind_by` (string (date)): Date of the note's reminder (YYYY-MM-DD). Must be provided together with `repeat_by`.
- `repeat_by` (string, one of: `daily`, `weekly`, `monthly`, `does_not_repeat`): How the reminder repeats. Must be provided together with `remind_by` (use `does_not_repeat` for a one-time reminder).
- `status` (string, one of: `active`, `archived`): The note status.

### Example request

```bash
curl -X PUT 'https://api.usewheelhouse.com/ss_api/v1/listings/{listing_id}/notes/{note_id}?channel=<channel>' \
  -H 'X-Integration-Api-Key: <your RM API key>' \
  -H 'Content-Type: application/json' \
  -d '{}'
```

Only required parameters and body fields are filled in, with placeholder values. Add the optional ones you need from the lists above; some are required in combination, as their descriptions say.

## Responses

### 200

The updated note.

Body (`application/json`): object `note_response`

A note on a listing.

- `id` (integer, required): The Wheelhouse internal note ID.
- `description` (string, nullable): The note text. `null` when the note has no text.
- `category` (array of string, each item one of: `base_price`, `last_minute_discounts`, `far_future`, `weekend_adjustment`, `seasonality_adjustment`, `demand_sensitivity`, `minimum_price`, `maximum_price`, `minimum_stays`, `discounts`, `far_future_premium`, `checkin_checkout`, `gap_night`, `occupancy_pacing`, `revenue_pacing`, `historical_anchoring`, `custom_date_ranges`, `calendar`): The Wheelhouse pricing settings sections the note relates to. Each value maps to a settings area in the Wheelhouse UI:
  `base_price` (Base Price), `last_minute_discounts` (Last-Minute Discounts), `far_future_premium` / `far_future` (Far-Future Premium), `weekend_adjustment` (Day-of-Week), `seasonality_adjustment` (Seasonality Adjustment), `demand_sensitivity` (Local Events), `minimum_price` (Price Floor), `maximum_price` (Price Ceiling), `minimum_stays` (Minimum Stay), `discounts` (Long-Term Discounts), `checkin_checkout` (Check-in/Check-out), `gap_night` (Gap Night), `occupancy_pacing` (Occupancy Pacing), `revenue_pacing` (Revenue Pacing), `historical_anchoring` (Historical Protections), `custom_date_ranges` (Custom Date Ranges), `calendar` (general calendar note not tied to a specific setting).
- `start_date` (string (date), nullable): First stay date the note applies to (YYYY-MM-DD).
- `end_date` (string (date), nullable): Last stay date the note applies to (YYYY-MM-DD).
- `remind_by` (string (date), nullable): Date of the note's reminder (YYYY-MM-DD).
- `repeat_by` (string, nullable, one of: `daily`, `weekly`, `monthly`, `does_not_repeat`): How the reminder repeats.
- `status` (string, required, one of: `active`, `archived`): The note status.
- `created_at` (string (date-time)): When the note was created (ISO-8601).
- `updated_at` (string (date-time)): When the note was last updated (ISO-8601).

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "id": 0,
  "description": "string",
  "category": [
    "base_price"
  ],
  "start_date": "2026-01-01",
  "end_date": "2026-01-01",
  "remind_by": "2026-01-01",
  "repeat_by": "daily",
  "status": "active",
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": "2026-01-01T00:00:00Z"
}
```

### 400

Invalid parameters.

### 401

API key authorization failed.

### 403

Listing authorization failed, or the API key is read-only.

### 404

Listing or note not found.

### 406

The listing is inactive. See the **Inactive Listings** section in the overview.

Body (`application/json`): object

- `error` (string, example: `Listing '12345' is inactive`)

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "error": "Listing '12345' is inactive"
}
```

### 409

A concurrent request for this note is already in progress. Retry after it completes.

### 429

Rate limit exceeded — the API key has sent too many requests. Wait before retrying. See the **Rate Limits** section in the overview for the recommended exponential backoff strategy.

Body (`application/json`): object

- `error` (string, example: `API token is at rate limit`)

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "error": "API token is at rate limit"
}
```
