CLcloudbeds
Events

Update an event note

Updates an existing note or archives it.

patch/events/v2/events/{eventId}/notes/{noteId}

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/events/v2/events/{eventId}/notes/{noteId}
  • Auth
    OAuth 2
    Authorization code: https://api.cloudbeds.com/auth/oauth/authorize
    Token URL: https://api.cloudbeds.com/auth/oauth/token scopes: write:group

Path parameters

eventIdstring required

Event ID or event code

noteIdstring required

Note ID

Headers

x-property-idstring required
Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Request body

eventIdstring

Event ID or event code (e.g., "12345" or "g162795")

noteIdstring

Note ID

textstring nullable

Updated note content

archivedboolean nullable

Archive the note

Example request

{
  "eventId": "12345",
  "noteId": "456",
  "text": "Guest requested late checkout - confirmed with management",
  "archived": true
}

Response

Note updated

successboolean required

Success status

Example response

{
  "success": true,
  "data": {
    "id": "144",
    "eventId": "12345",
    "text": "Guest requested late checkout for the wedding party",
    "createdBy": "John Smith",
    "createdAt": "2025-01-15T10:30:00Z",
    "updatedAt": "2025-01-15T10:30:00Z",
    "archivedAt": "2025-01-20T14:45:00Z"
  }
}

Changes

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