GUguesty
Saved Replies

List saved replies by listing

Changed on

Returns saved replies filtered by the listing id. By default only ids are returned.

get/saved-replies/listing/{listingId}

Request

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

Path parameters

listingIdstring required

Limit results to a specific listing

Query parameters

limitinteger

Pagination limit, max: 100

skipinteger

How many results should be skipped to get to the current page

accountIdstring

Limit results to a specific account

returnDefaultboolean

To get Guesty defaults SRs

fieldsstring

Selection of fields, separated by space. See response schema to get list of fields

sortstring

Field to sort by. Prepend - for DESC.

qstring

Search query string. Searches in question and folder. Search is case-insensitive.

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
    • info

      api operation id inboxSavedReplyListingList 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