v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Update a guest note

This API helps you to update the details of the specified guest note.

You must specify the unique identifier of the guest as guest_id and the note as note_id in the API request.

Important

You can change the notes and note_type elements by using this API. You can change the alert of a note by modifying the note_type as generic = 2. You cannot update note_type for a private guest note.

put/v1/guests/{guest_id}/notes/{note_id}

Path parameters

guest_idstring required

Mandatory Unique 32-character identifier of the guest.

note_idstring required

Mandatory Unique 32-character identifier of the guest note.

Request body

idstring

Unique identifier of the center.

is_privateboolean

This field denotes if the note is a private one. True - means the note is private. False - means the note is not private.

alertboolean

This denotes if the alert for the note is enabled or not. True - means the alert is ON. False - means the alert is OFF.

note_type'10' | '3' | '4' | '2'

Indicates the type of the note. 10 Show on opening Guest History, 3 Show during check-in, 4 Show when booking an appointment, 8 Show when taking payment, 2 Generic

notesstring

This is the note for the guest on the appointment.

Response

200

idstring

is_privateboolean

alertboolean

note_typeinteger

notesstring

created_datestring

Example response

{
  "id": "9805fb48-4c52-44fc-90da-66b1d063e8bb",
  "alert": true,
  "note_type": 8,
  "notes": "sample string 4",
  "center": {
    "id": "c56f4e05-62b5-4033-b42e-b72db37722df",
    "name": "London"
  },
  "created_date": "2018-12-20T11:06:57"
}