# Variables

{% hint style="success" %}
**IN BRIEF**

Take your AI agents even further with custom variables that let you dynamically personalize your AI agents based on context.
{% endhint %}

{% hint style="info" icon="lightbulb" %}
The **custom variables** allow dynamic insertion of information into the responses generated by your AI agents.\
They are especially useful when you manage **multiple brands or locations** and certain information must vary depending on the context (for example a booking link, a menu, or a specific description).
{% endhint %}

{% hint style="info" icon="shield-check" %}
**ACCESS RIGHTS**

To edit Variables in your Fullwhere workspace, you must be a supervising member with Administrator rights.
{% endhint %}

A variable is defined once in your workspace, then you can **define a different value for each location or brand**.

For example:

* a variable **activity description** can contain different text for each of your locations
* a variable **booking link** can point to a different URL for each of your establishments

When an AI agent generates a response, the variable used in its instructions is **automatically replaced with the value corresponding to the location involved in the customer interaction**.

***

To access the variable settings, go to **Automation → Variables.**

## The variables table

In the **Automation → Variables**section, you will find the list of all custom variables in your workspace.

For each variable, the table displays:

* **Name** : the readable name of the variable
* **Variable** : the placeholder to use in agents
* **Type** : the variable type (Text or Link)

From this table, you can:

* search for a variable using the search bar
* create a new variable
* edit an existing variable
* delete a variable

The actions **Edit** and **Delete** are accessible via the three dots **⋯** to the right of each variable.

***

## Create a custom variable

To create a variable, click **Create a variable** and configure your variable fields

{% stepper %}
{% step %}

### Type

Determines the content type of the variable:

* **Text** : for text content (e.g. activity description)
* **Link** : to insert dynamic URLs (e.g. booking link)
  {% endstep %}

{% step %}

### Name

Readable name of the variable in the interface.\
Example: `Booking link`
{% endstep %}

{% step %}

### Variable (placeholder)

Identifier used in agents to call the variable.

Best practices:

* use only **lowercase letters**
* use **hyphens or underscores**
* **no accents or spaces**

Example: `booking_link`.

To use a custom variable in an AI agent, you must insert it into your agent's instructions using `{{}}`, for example `{{booking_link}}`.
{% endstep %}
{% endstepper %}

***

## Edit a variable

To edit an existing variable:

1. Go to **Automation → Variables**
2. Click the menu **⋯** to the right of the variable
3. Select **Edit**

You can edit:

* **the variable name**
* **the placeholder (variable)**

Once created, the type of a variable cannot be changed.

{% hint style="danger" %}
If you change the **placeholder** of a variable, you will also need to **update all occurrences of that variable in your agents**.\
Otherwise, the old references will no longer work.
{% endhint %}

***

## Delete a variable

To delete a variable:

1. Go to **Automation → Variables**
2. Click the menu **⋯** to the right of the variable
3. Select **Delete**
4. Confirm deletion

{% hint style="danger" %}
Deleting a variable results in:\
\- permanent deletion of the variable\
\- deletion of all its associated values in your brands and locations

If the variable was used in AI agents, it will no longer be recognized in the instructions.

**This action is irreversible.**
{% endhint %}

## Set the value of a variable for a brand or a location

Once a custom variable has been created, you can **set its value for each brand or location** so that it can be used correctly by your AI agents.

{% hint style="info" icon="shield-check" %}
**ACCESS RIGHTS**

To change the value of a variable for a brand or location, you must have editing rights on that resource.
{% endhint %}

These values make it possible to dynamically adapt the generated responses based on the brand or establishment involved in the customer interaction.

Go to Settings > [Brands](https://app.fullwhere.com/settings/brands) or [Locations](https://app.fullwhere.com/settings/stores) and select the entity to edit, then in the top navigation bar, click the **Variables**

tab You will access the list of **custom variables available in your Fullwhere workspace**.

The table shows:

* **Name** : the name of the variable
* **Value** : the value currently set for the brand or location

If **no value is set**, a **dash (-)** appears in the value column.

#### Set or edit a value

To set or edit the value of a variable:

1. Click the ✏️ icon on the right of the row
2. Enter the desired value
3. Click **Save**

The value set will then be used by your **AI agents** when the variable is called in their instructions: when generating a response, the variable used in the agent will be **automatically replaced with the value corresponding to the relevant brand or location**.


---

# Agent Instructions: 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.fullwhere.com/documentation/documentation-en/automations/variables.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.
