> For the complete documentation index, see [llms.txt](https://docs.guestway.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.guestway.io/properties/custom-fields.md).

# Custom fields

Custom fields are extra fields that you set up for your properties or reservations, for the data your team needs that Guestway has no field for.

{% hint style="info" %}
**Requirements**

* The permission to read custom field definitions, to open the page, and to edit them, to create a field. See [Users and roles](https://docs.guestway.io/account-and-administration/users-and-roles.md).
  {% endhint %}

## Custom fields list

Custom fields are in **Settings** → **Organization** → **Custom Fields**. The page is not available in Hub mode.

The list has a search field (*Search...*), which finds the name and the variable, and **Create**. Click a field to open its details.

| Column         | What it shows                                                                             |
| -------------- | ----------------------------------------------------------------------------------------- |
| (no title)     | The logo of the source: Guestway or the integration. A star means the field is important. |
| **Name**       | The name of the field.                                                                    |
| **Variable**   | The code of the field, for example `{{ parking_info }}`.                                  |
| **Value Type** | **Text**, **Number**, **Yes / No**, **List**, **Date** or **Time**.                       |
| **Target**     | **Listing • Multi-unit • Complex**, **Listing • Multi-unit** or **Reservation**.          |
| **Visible**    | **Visible** or **Hidden**.                                                                |

## Fields

**Create** opens **Create custom field**.

| Field             | What it does                                                                 | Limits                                                                                                                      |
| ----------------- | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| **Name**          | The name of the field, wherever it shows.                                    | Required. Up to 255 characters.                                                                                             |
| **Variable**      | A unique code for the field. It is filled in from the name.                  | Required. Lowercase letters, numbers and underscores, starting with a letter. Up to 64 characters. Cannot be changed later. |
| **Description**   | Shows as an info icon next to the field.                                     | Up to 500 characters.                                                                                                       |
| **Target**        | **Property** (listings, multi-units and complexes) or **Reservation**.       | Required. **Reservation** by default. Cannot be changed later.                                                              |
| **Visible**       | When off, the field does not show on properties, in the inbox or in filters. | On by default.                                                                                                              |
| **Important**     | Shows the field first, with a star.                                          | Off by default.                                                                                                             |
| **Used by AI**    | When on, the AI can read the value of the field when it replies to guests.   | On by default.                                                                                                              |
| **Value Type**    | See *Value types*.                                                           | Required. **Text** by default. Cannot be changed later.                                                                     |
| **List Options**  | The options of a **List** field. Press Enter after each option.              | At least 1 and up to 100 options, each up to 100 characters.                                                                |
| **Default Value** | The value a new record starts with.                                          | For reservations: only new reservations. For properties: all listings, multi-units and complexes without a value.           |

After **Create**, you see *Successfully created!* and the form is empty again for the next field.

## Value types

| Value type   | What it holds                                        | Limits                  |
| ------------ | ---------------------------------------------------- | ----------------------- |
| **Text**     | Free text. Type **@** to insert a template variable. | Up to 5000 characters.  |
| **Number**   | A number.                                            | None                    |
| **Yes / No** | **Yes** or **No**.                                   | None                    |
| **List**     | One of the **List Options**.                         | None                    |
| **Date**     | A date, in the form dd/MM/yyyy.                      | None                    |
| **Time**     | A time of day.                                       | In steps of 10 minutes. |

## Field details

The details show the **Important** badge, or **Inactive** when the field is hidden. The pencil icon on **Information** changes **Visible**, **Important**, **Used by AI**, **Name**, **List Options**, **Default Value** and **Description**. **Variable**, **Value Type** and **Target** cannot be changed.

A field added by an integration also has an **Integration** card with a link to the integration. Only **Visible**, **Important**, **Used by AI** and **Description** can be changed.

**Delete Custom Field** deletes the field after a confirmation:

* The values of the field on reservations and properties are deleted too. They are erased for good after 30 days.
* Message variables that used the field become empty text.
* You cannot delete a field that an automation still uses. Guestway tells you which automation uses it.
* You cannot delete a field added by an integration: *Fields added by an integration can't be deleted directly. Hide the field instead.* Turn off **Visible** instead.

## Where custom fields show

| Place                                                | What it shows                                                                                                                  | See                                                                                                                                   |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| **Custom Fields** tab of a property                  | The values of the property fields, by listing, multi-unit and complex.                                                         | [Property custom fields](https://docs.guestway.io/properties/custom-fields/property-custom-fields.md)                                 |
| **Reservation** tab of the reservation details panel | **Custom Fields (N)**: the values of the reservation fields. The pencil icon changes them: *Custom fields saved successfully.* | [Reservation details panel](https://docs.guestway.io/inbox-and-messaging/unified-ai-inbox/reservation-details-panel.md#custom-fields) |
| **Listing** tab of the reservation details panel     | **Custom Fields (N)**: the values of the property fields, read-only.                                                           | [Reservation details panel](https://docs.guestway.io/inbox-and-messaging/unified-ai-inbox/reservation-details-panel.md#listing-tab)   |

The filters of the inbox and of **Reservations** have **Listing custom field**, **Multi-unit custom field**, **Complex custom field** and **Reservation custom field**. The multi-calendar has **Listing custom field**. Pick the filter, then the field, then the value, or **Specified** or **Unspecified**.

## Custom fields in messages

The **Variable** of a field is its template variable, for example `{{parking_info}}`. Type **@** in a message and pick the field: reservation fields are in the group **Reservation**, property fields in the group **Property**. The variables work wherever template variables work, for example in saved replies, automations and custom HTML email templates. Only fields with **Visible** on are in the list.

| Value of the field                     | What the message shows                                                   |
| -------------------------------------- | ------------------------------------------------------------------------ |
| **Text**, **List**, **Date**, **Time** | The value as it is saved.                                                |
| **Number**                             | The number.                                                              |
| **Yes / No**                           | *true* or *false*.                                                       |
| No value                               | The **Default Value** of the field. Without a default value, empty text. |

For a property field, Guestway uses the value of the listing. If the listing has no value, it uses the value of the multi-unit. For a field with the target **Listing • Multi-unit • Complex**, it then uses the value of the complex.

If you turn off **Visible** for a field, its variable becomes empty text in messages.

## Custom fields in automation conditions

Reservation fields are in the condition category **Reservation - Custom Field**, and property fields in **Property - Custom Field**. A field with no value matches only **Doesn't exist** and **Is (or doesn't exists)**. For the operators of each value type, see [Automations](https://docs.guestway.io/reservations-and-operations/automations.md#custom-field-conditions).

## Related

* [How to create a custom field](https://docs.guestway.io/properties/custom-fields/how-to-create-a-custom-field.md)
* [How to set a custom field for a whole complex](https://docs.guestway.io/properties/custom-fields/how-to-set-a-custom-field-for-a-whole-complex.md)
* [Property custom fields](https://docs.guestway.io/properties/custom-fields/property-custom-fields.md)
* [Saved replies](https://docs.guestway.io/inbox-and-messaging/saved-replies.md#template-variables): template variables
* [Automations](https://docs.guestway.io/reservations-and-operations/automations.md#custom-field-conditions): custom field conditions


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.guestway.io/properties/custom-fields.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
