Sign in
CalendarNotes

Create a calendar note

Creates a new CalendarNote against a site for a given date. Requires the RESERVATIONS_MANAGE permission on the target site.

post/shop/calendar-notes

Request body

bodystring required

The note text. Plain text only — line breaks are preserved but no markdown is rendered. There is no hard length limit, but keep it short so it reads well in the calendar.

datestring date required

The calendar date the note applies to, in YYYY-MM-DD format. The date is interpreted in the site's local timezone.

site_idstring uuid

ID of the site to attach the note to. The caller's API key must have access to the site and the RESERVATIONS_MANAGE permission on it. Defaults to the site from the request context when omitted.

Example request

{
  "body": "Public holiday — front desk closes at 16:00.",
  "date": "2026-05-25",
  "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.