> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://support.uplisting.io/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Automated Message filters

# Automated Message filters

You can use the automated message filters in combination to control which guests receive the message.

# 1. Booking site
The booking site filter allows you to select which booking site(s) the message rule should send to. If you don't choose any booking sites, Uplisting defaults to having all sites selected.

###  Booking site filter options

* Airbnb
* Booking.com
* Vrbo
* Google
* Uplisting direct bookings

> **💡** You can select multiple booking sites with this filter
![](https://storage.crisp.chat/users/helpdesk/website/-/1/b/e/b/1beb313cc044d100/image_i8qc3b.png =1000x257)

# 2. Booking lead time
Booking lead time refers to the time remaining between the reservation being created and the check-in time. For example, if a booking was made today at 12 pm and check-in is tomorrow at 10 am, the booking lead time is 22 hours.

> **👍 How and why to use booking lead time**
> Booking lead time is helpful to send specific messages to last-minute bookings. For example, merge your new booking messaging with check-in instructions, so last-minute guests only receive one message rather than 2.
>
> When using booking lead time in this way, ensure you add the filter to both messages. The last-minute message booking lead time should be set to (for example) `less than 24 hours` with the other messages having a booking lead time of `more than 24 hours`

###  Booking lead time filter options

* more than x hours
* less than x hours
* exactly x hours
||| The 'exactly x hours' filter option is mostly redundant as it only triggers if the guest books exactly x hours before arrival.

 ![](https://storage.crisp.chat/users/helpdesk/website/-/1/b/e/b/1beb313cc044d100/image_15i4587.png =1000x360)


# 3. Booking duration
Booking duration refers to the length of the booking. For example, a booking duration of 2 days means the guest is staying at your property for 2 nights.

> **👍 How and why to use booking duration:**
> Booking duration is helpful to send specific messages depending on how long a guest stays. For example, if a guest stays for 1 night, it may not make sense to send a message on the first morning of the stay asking how they are enjoying their stay so far, as the guest is preparing to check out.
>
> Similarly, you may need to send specific instructions to guests staying over 7 nights, reminding them to leave the trash out.

###  Booking duration filter options

* more than x nights
* less than x nights
* exactly x nights

![](https://storage.crisp.chat/users/helpdesk/website/-/1/b/e/b/1beb313cc044d100/image_czncff.png =1000x395)

# 4. Booking payment status
The booking payment status refers to whether a booking has been paid.

### Booking payment status filter options

* paid (in full)
* partially paid (a split payment booking with the first installment paid)
* not paid (not fully paid)
* payment failed (an attempt to take a payment failed)

> **💡**Send check-in instructions if booking payment status = paid. 
>     Send a payment reminder message with a link to the booking payment page if payment status = unpaid.

> **⚠️ Paid status**
> All Airbnb and Booking.com virtual credit card and bank transfer bookings are assumed to be paid.
>
> **⚠️ Payment failed status**
> A booking is in this payment state in the following scenarios: 1. A booking.com booking using a real guest credit card (not a virtual card) where the payment failed. 2. An Uplisting, Vrbo, or Google split payment booking where the second instalment has failed.

![](https://storage.crisp.chat/users/helpdesk/website/-/1/b/e/b/1beb313cc044d100/image_anu3ws.png =1000x351)

# 5. Security deposit

> **⚠️ Important**
> The security deposit filter refers to the Uplisting security deposit feature and not security deposit features provided by booking sites.

The security deposit filter is activated when the [Uplisting Security Deposit - Protect](https://uplisting.crisp.help/en/article/introduction-to-protect-qx5qib/) feature is active.

### Security deposit filter options

* has been collected
* needs payment information
* payment method has been provided
* collection attempt failed

###### Has been collected option
Security deposit has been collected is true when a deposit has been paid, pre-authorized or overridden.

> **💡Use this option when you want to send sensitive messages such as check-in instructions.**
> If you override the requirement for a booking to provide a security deposit, Uplisting will treat this booking as **has been collected = true**.

### 
###### Needs payment information option
Security deposit needs payment information is true when a guest has yet to provide a credit card for their deposit.

> **💡**Use this option when sending messages asking for your guest to provide a payment method for their deposit.

### 
###### **Payment method has been provided option**
Security deposit payment method has been provided is true when a guest has provided payment information but the deposit has not yet been successfully charged for or has not failed to be charged.

> **💡**Use this option when you only want to send a message to a guest that has provided payment information. Don't use this option to limit check-in instructions from sending as it does not guarantee a deposit will successfully be charged.
>     If you override the requirement for a booking to provide a security deposit, Uplisting will treat this booking as **payment method has been provided = true**.

### 
###### **Collection attempt failed option**
Security deposit collection attempt failed is true when Uplisting's attempts to charge for a deposit fails.

> **💡**Use this option when chasing a guest to provide new payment information to pay for their security deposit.

> ⚠️Important
> Uplisting first attempts to charge a security deposit 24 hours before the guest's arrival time. Uplisting attempts to charge a further 8 times over a few hours. The last attempt is 6 hours after the first attempt. If check-in is 3 pm, the last attempt to charge the deposit will be 9 pm. **In this example, 9 pm is when the security deposit collection attempt failed will be triggered.**

![](https://storage.crisp.chat/users/helpdesk/website/-/1/b/e/b/1beb313cc044d100/image_164k79r.png =1000x406)



# 6. Rental agreement
The rental agreement filter is activated when the [eSign rental agreements](https://uplisting.crisp.help/en/article/esign-rental-agreements-1mn28ug/) feature is active.

> **💡** If you have enabled this filter on a message but have not enabled the feature, Uplisting will ignore the filter and send messages.
>      If you override the requirement for a booking to sign a rental agreement, Uplisting will treat this booking as **signed**.

### Rental agreement filter options

* signed
* not signed
![](https://storage.crisp.chat/users/helpdesk/website/-/1/b/e/b/1beb313cc044d100/image_1ygaxyo.png =1000x317)




# 7. Guest identity
The guest identity filter is activated when the [Guest identification verification](https://uplisting.crisp.help/en/article/guest-identification-verification-11gqur/) feature is active.

> **💡**If you have enabled this filter on a message but have not enabled the feature, Uplisting will ignore the filter and send messages.
>     If you override the requirement for a booking to verify their identity, Uplisting will treat this booking as **verified**.
### 
Guest identity filter options

* verified
* not verified

![](https://storage.crisp.chat/users/helpdesk/website/-/1/b/e/b/1beb313cc044d100/image_1wg5o0u.png =1000x317)


# 8. Guest Review
You can set messages based on whether a guest has or hasn't left a review yet, perfect for polite review nudges
### Guest review filter options:

* has been left
* has not been left
![](https://storage.crisp.chat/users/helpdesk/website/-/1/b/e/b/1beb313cc044d100/image_1ajm84a.png =1000x317)

# 9. Guest Stay
The **Guest stay** filter allows you to send a message based on whether the guest is currently staying at the property.

### Guest Stay filter options:

* **Guest is currently staying**
* **Guest is not currently staying**
**Example use cases:**
* Send a message with mid-stay information only to guests who are **currently staying**.
* Send a message with pre-arrival information only to guests who are **not currently staying**.

![](https://storage.crisp.chat/users/helpdesk/website/-/1/b/e/b/1beb313cc044d100/image_72zbyx.png =1000x475)


# 10. Week of the year
The **Week of the year** filter allows you to send messages based on whether the current week number is even or odd.

### Week of the year filter options:

* **Is even number**
* **Is odd number**
### Example use case:

* If garbage collection alternates between weeks, you can use the week-of-the-year filter to send the appropriate garbage disposal instructions on **even-numbered weeks** and a different message on **odd-numbered weeks**.

![](https://storage.crisp.chat/users/helpdesk/website/-/1/b/e/b/1beb313cc044d100/image_zwtrz4.png =1000x295)



