GUguesty
Saved Replies

Create a saved reply

Changed on

Create a saved reply for your account. question and answer are required. Leave listingsIds empty to make the reply account-wide, or list the listings it should apply to. Returns the created saved reply.

post/saved-replies

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/saved-replies
  • Auth
    API key in header authorization

Request body

questionstring required

The question or trigger phrase the saved reply answers.

answerstring required

The reply text sent to the guest.

applyWhenHasBookingboolean

Whether this saved reply applies to guests with an existing booking.

applyWhenNoBookingboolean

Whether this saved reply applies to guests without an existing booking.

isAbstractboolean

Whether this is an abstract saved reply (a template, not usable directly).

type'user' | 'guest' | 'contact' | 'review'

Type of recipient this saved reply is intended for.

language'en' | 'fr' | 'es' | 'it' | 'ru' | 'ja' | 'zh'

Language of the saved reply.

excludeListingIdsstring[]

Exclude saved reply from the specific listings

listingsIdsstring[]

Apply saved reply for the specific listings

folderstring

Folder the saved reply is organized under.

tagsstring[]

Array of free-text tags associated with the saved reply.

Example request

{
  "question": "Mirror, mirror, on the wall, Who in this land is fairest of all?",
  "answer": "not you?"
}

Response

OK

questionstring

The question or trigger phrase the saved reply answers.

answerstring

The reply text sent to the guest.

applyWhenHasBookingboolean

Whether this saved reply applies to guests with an existing booking.

applyWhenNoBookingboolean

Whether this saved reply applies to guests without an existing booking.

isAbstractboolean

Whether this is an abstract saved reply (a template, not usable directly).

type'user' | 'guest' | 'contact' | 'review'

Type of recipient this saved reply is intended for.

language'en' | 'fr' | 'es' | 'it' | 'ru' | 'ja' | 'zh'

Language of the saved reply.

excludeListingIdsstring[]

Exclude saved reply from the specific listings

listingsIdsstring[]

Apply saved reply for the specific listings

folderstring

Folder the saved reply is organized under.

tagsstring[]

Array of free-text tags associated with the saved reply.

accountIdstring

Unique Guesty listing/unit type ID.

_idstring

Unique Guesty listing/unit type ID.

Example response

{
  "question": "TV",
  "answer": "Hi {{user}},\n\nWe have a 42\" Samsung LED in the living room.",
  "language": "en",
  "excludeListingIds": [
    "563e0b6a08a2710e00057b82"
  ],
  "listingsIds": [
    "563e0b6a08a2710e00057b82"
  ],
  "folder": "City",
  "filters": {
    "_id": "563e0b6a08a2710e00057b82"
  },
  "accountId": "563e0b6a08a2710e00057b82",
  "_id": "563e0b6a08a2710e00057b82"
}

Changes

  • 3122b8618183Revision changes
    • breaking

      added subschema #1 to the request body allOf list

    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      api operation id inboxSavedReplyCreate was added

    • info

      added subschema #1 subschema #2 to the response body allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body allOf list for the response status