Sign in
CalendarNotes

Update a calendar note

Partially updates a CalendarNote. Every field is optional; only fields you send are written. Requires the RESERVATIONS_MANAGE permission on the note's current site (and the target site too, if site_id is changed).

put/shop/calendar-notes/{calendarNoteId}

Request body

bodystring

Replacement note text, shown to staff on the calendar view. Plain text only — HTML tags are stripped.

datestring date

Move the note to a different calendar date, in YYYY-MM-DD format.

site_idstring uuid

Move the note to a different site. The caller's API key must have access to both the old and new site.

Example request

{
  "body": "Public holiday — front desk closes at 17:00.",
  "date": "2026-05-26",
  "site_id": "11111111-1111-1111-1111-111111111111"
}

Response

A single CalendarNote.

Example response

{
  "data": {
    "id": "5f1234567890abcdef123456",
    "site_id": "11111111-1111-1111-1111-111111111111",
    "body": "Public holiday — front desk closes at 16:00.",
    "date": "2026-05-25",
    "created_by_id": "33333333-3333-3333-3333-333333333333",
    "updated_by_id": "33333333-3333-3333-3333-333333333333",
    "created_at": "2026-05-23T09:30:00Z",
    "updated_at": "2026-05-23T09:30:00Z"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.