put
https://api.zenoti.com/v1/guests//notes/
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_typeelements by using this API.
You can change the alert of a note by modifying thenote_typeas generic = 2.
You cannot updatenote_typefor a private guest note.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Request Body Parameters
| Name | Type | Description |
|---|---|---|
| id | guid | Unique 32-character identifier of the guest note. |
| is_private | boolean | Indicates whether the note is private. |
| alert | boolean | Indicates whether the guest note alert is active. |
| note_type | enum | Type of the guest note: Unknown - 0, Generic - 2, Checkin - 3, Booking - 4, Payment - 8, Profile - 10 |
| notes | string | Message inside the note. |
| center | object | Object that contains the details of the center. |
| added_by | object | Object that contains the added by details. |
| created_date | datetime | Date on which the note was created. |
| is_post_to_pms | boolean | Indicates whether the chkPostToPms check box has been selected. |
| post_to_pms_response_message | string | Error message for ChkPostToPMS. |
| entity_pk | int | Entity For which the notes is added. |
| entity_name | string | Entity Name For which the note is added. |
Response Details
| Name | Type | Description |
|---|---|---|
| id | guid | Unique 32-character identifier of the guest note. |
| is_private | boolean | Indicates whether the note is private. |
| alert | boolean | Indicates whether the guest note alert is active. |
| note_type | enum | Type of the guest note: Unknown - 0, Generic - 2, Checkin - 3, Booking - 4, Payment - 8, Profile - 10 |
| notes | string | Message inside the note. |
| center | object | Object that contains the details of the center. |
| added_by | object | Object that contains the added by details. |
| created_date | datetime | Date on which the note was created. |
| is_post_to_pms | boolean | Indicates whether the chkPostToPms check box has been selected. |
| post_to_pms_response_message | string | Error message for ChkPostToPMS. |
| entity_pk | int | Entity For which the notes is added. |
| entity_name | string | Entity Name For which the note is added. |