v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Create a guest note

This API helps you to create a note for the guest.

You must specify the unique identifier of the guest as <glossary:guest_id> in the API request.

post/v1/guests/{guest_id}/notes

Path parameters

guest_idstring required

Unique identifier of the guest.

Request body

idstring

Unique identifier of the guest note.

namestring

Name of the center where the guest note is created.

alertboolean

Indicates whether the guest note alert is active.

created_datestring

Date when the note was created.

entity_namestring

Entity Name For which the note is added.

entity_pkinteger

Entity for which the note is added.

is_privateboolean

Indicates whether the note is private.

note_type'0' | '2' | '3' | '4' | '8' | '10'

Type of the guest note: Unknown - 0, Generic - 2, Checkin - 3, Booking - 4, Payment - 8, Profile - 10

notesstring

The content of the guest note.

privacy_type'2' | '3'

Type of the privacy note. Privacy 2 and Privacy 3

Response

200

idstring

is_privateboolean

alertboolean

note_typeinteger

notesstring

created_datestring

Example response

{
  "id": "9805fb48-4c52-44fc-90da-66b1d063e8bb",
  "alert": true,
  "note_type": 10,
  "notes": "Guest always prefer evening timings",
  "center": {
    "id": "c56f4e05-62b5-4033-b42e-b72db37722df",
    "name": "London"
  },
  "added_by": {
    "id": "c56f4e05-62b5-4033-b42e-b72db37722df",
    "name": "admin owner"
  },
  "created_date": "2018-12-20T11:06:57"
}