> For the complete documentation index, see [llms.txt](https://docs.flip.to/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flip.to/docs/integrations/email-marketing/snippets/confirmation-email.md).

# Confirmation email

**Add a banner to your confirmation email to invite guests to share about their stay with friends and family.**

A dynamically generated, linked image can be added to your email template that is unique for each guest and can be easily tweaked from your Flip.to account, including size, messaging and styling.

{% hint style="info" %}
The banner can easily be toggled on or off from your account. If it is turned off, the image will not be displayed and a transparent 1x1 pixel will be served in its place.
{% endhint %}

## Banner code snippet

The basic structure of the snippet to be added is:

```html
<a href=”LinkURL”><img src=”ImageURL” alt=”ImageDescription”/></a>
```

<table data-header-hidden><thead><tr><th width="243"></th><th></th></tr></thead><tbody><tr><td>LinkURL</td><td>Points guests to their share page: <code>https://flip.to/property/confirmation/email/link</code></td></tr><tr><td>ImageURL</td><td>Loads the image asset that invites guests to share about their upcoming trip: <code>https://flip.to/property/confirmation/email/image</code></td></tr><tr><td>ImageDescription</td><td><p>Makes sure your image is screen-reader friendly and compliant with the Americans with Disabilities Act (ADA). Add in the alt attribute directly in the tag.</p><p>We suggest the following alt text for the confirmation email image:</p><p><code>alt=”Share about your upcoming trip with friends and family and they can unlock a special bonus towards a future stay with us.”</code></p></td></tr></tbody></table>

<pre class="language-html" data-title="Sample" data-overflow="wrap"><code class="lang-html">&#x3C;a target="_blank"
<strong>href="https://flip.to/property/confirmation/email/link?companycode=XX&#x26;code=YY&#x26;pmsnumber=12345&#x26;crsnumber=CRS56333&#x26;loyalty=70344&#x26;first=John&#x26;last=Smith&#x26;email=john@flip.to&#x26;startdate=2021-12-14&#x26;enddate=2021-12-16&#x26;type=AB&#x26;ratecode=ABC&#x26;groupCode=Wedding&#x26;promoCode=flipto&#x26;language=en&#x26;currency=USD&#x26;amount=1234.45">
</strong><strong>&#x3C;img src="https://flip.to/property/confirmation/email/image?companycode=XX&#x26;code=YY&#x26;pmsnumber=12345&#x26;crsnumber=CRS56333&#x26;loyalty=70344&#x26;first=John&#x26;last=Smith&#x26;email=john@flip.to&#x26;startdate=2021-12-14&#x26;enddate=2021-12-16&#x26;type=AB&#x26;ratecode=ABC&#x26;groupCode=Wedding&#x26;promoCode=flipto&#x26;language=en&#x26;currency=USD&#x26;amount=1234.45" alt="Share about your upcoming trip with friends and family and they can unlock a special bonus towards a future stay with us."/>
</strong>&#x3C;/a>
</code></pre>

### Parameters

Below are the parameters that should be appended to both the **LinkUrl** and **ImageUrl**. All values should be properly URL encoded.

| Name        | Value                                                                 | Description                                                                                                                                                                                                                                                                                                                   |
| ----------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| companyCode | <p>Your Flip.to company</p><p>code</p>                                | Please check with your [Customer Success Manager](/docs/support/customer-success.md) if needed and replace `XX` with your own companyCode.                                                                                                                                                                                    |
| code        | The property code used by your booking engine                         | Replace `YY` with your own property booking engine code.                                                                                                                                                                                                                                                                      |
| crsnumber   | <p>The reservation CRS number,</p><p>if available</p>                 |                                                                                                                                                                                                                                                                                                                               |
| pmsnumber   | The reservation PMS number, if available.                             |                                                                                                                                                                                                                                                                                                                               |
| loyalty     | Guest's loyalty program number, if any                                |                                                                                                                                                                                                                                                                                                                               |
| first       | Guest's first name                                                    |                                                                                                                                                                                                                                                                                                                               |
| last        | Guest's last name                                                     |                                                                                                                                                                                                                                                                                                                               |
| email       | Guest's email address                                                 | In cases that there may be more than one possible email available, this can be populated with a pipe (                                                                                                                                                                                                                        |
| startDate   | Guest’s check-in date                                                 | <p>Dates should be formatted as <strong>yyyy-M-d</strong></p><p>For example: <code>2028-5-15</code> or <code>2028-05-15</code></p>                                                                                                                                                                                            |
| endDate     | Guest’s check-out date                                                | If this is not available please see the nights parameter under advanced configuration below.                                                                                                                                                                                                                                  |
| type        | The guest’s room type, if available                                   | This should include the booking engine internal code, and not the room type description.                                                                                                                                                                                                                                      |
| rateCode    | The guest’s rate code, if available                                   |                                                                                                                                                                                                                                                                                                                               |
| groupCode   | The guest’s group code (or block code), if available                  |                                                                                                                                                                                                                                                                                                                               |
| promoCode   | The guest’s promo code, if available                                  |                                                                                                                                                                                                                                                                                                                               |
| language    | The language ANSI code the guest has used to make the reservation     | <p>For English use <code>en</code>, French <code>fr</code>, etc. Here’s a complete <a href="https://www.loc.gov/standards/iso639-2/php/code_list.php">list of ISO 639-1 language codes</a></p><p>Optionally a culture name can be used as well. For example this can be set to <code>en-US</code> or <code>en\_US</code>.</p> |
| currency    | The 3 character currency code the guest has used to made the purchase | Here's a [complete list of currency codes](https://www.xe.com/currency/). For instance USD for US Dollars.                                                                                                                                                                                                                    |
| amount      | The total amount used for the purchase based on the defined currency  | Amount should be supplied as a valid number including a decimal point if appropriate.                                                                                                                                                                                                                                         |

### Advanced Configuration <a href="#scenarios" id="scenarios"></a>

| Name             | Value                                                                                                                                                       | Description                                                                                                                                                                                                                                                                                        |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| nights           | <p><em>Optional</em></p><p>The number of nights that the guest has stayed at the hotel. This should be set as a number.</p>                                 | If `endDate` is not available, this field can be set to the actual or estimated (i.e. the average night stay) length of guest stay.                                                                                                                                                                |
| dateFormat       | <p><em>Optional</em></p><p>Specifies a different date format for the <code>startDate</code> and <code>endDate</code> parameters.</p>                        | <p>By default dates should be specified as <strong>yyyy-M-d.</strong> However, you can change the default format by entering the appropriate format here.<br></p><p>For example, if dates are entered as <code>12/31/2028</code> the date format to be specified is <strong>M/d/yyyy</strong>.</p> |
| mobile           | <p><em>Optional</em></p><p>Setting to <code>true</code> indicates that the mobile version of the image should be displayed. Default is a desktop image.</p> | This is only supported for the **ImageURL.**                                                                                                                                                                                                                                                       |
| overrideImageUrl | <p><em>Optional</em></p><p>Overrides the default image with a custom image.</p>                                                                             | When using custom images, one should use the https protocol, and might want to create a unique image per language.                                                                                                                                                                                 |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.flip.to/docs/integrations/email-marketing/snippets/confirmation-email.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
