---
metadata:
  - name: generator
    content: Diplodoc Platform v5.19.6
alternate:
  - https://docs.routeq.com/doc/en/vrp/interface-presets.md
  - https://docs.routeq.com/doc/tr/vrp/interface-presets.md
title: RouteQ — working with the interface — presets
---
> **Documentation Index:** Fetch the complete configuration index at https://docs.routeq.com/doc/en/llms.txt


# Presets

## Preset overview {#presets-about}

A preset is an existing set of settings that is stored in JSON format and can be included in an API request.


{% include [presets-preset-types](_includes/preset-types-10814e8028db.md) %}

A preset of a certain type can only be included in the corresponding field of the API request. To learn more, see [Using presets](https://docs.routeq.com/doc/en/vrp/presets.md).

Public presets are available to everyone. Companies can create their own presets from scratch or by modifying public ones.

Presets are usually created and used in sets, with each set containing presets of different types and geared towards solving a specific task. Presets in a set normally have the same name.

![](./_images/presets-public.png)


## Creating a preset {#presets-adding}

1. Under **Settings** → **Presets**, click **Private**.
2. Click **Add preset**.
3. Select a preset type.
4. Enter a preset name. The name for presets of the same type must be unique. It cannot start with `public_` or contain a comma.
5. Enter a description (optional) of the situations you plan to use it in.
6. In the edit window, prepare the preset (settings in JSON format). To format the text, click the **Beautify** button.
7. When the preset is ready, click **Save**.

![](./_images/presets-company.png)

When saving the preset, its contents are validated. If the JSON is invalid, you'll receive a message indicating the string that contain errors. Validation is also performed when changing the preset type. An invalid preset cannot be saved.

In the fields, you can specify geofences defined in your [company's master data](https://docs.routeq.com/doc/en/vrp/interface-geozones.md) and [public geofences](https://docs.routeq.com/doc/en/vrp/interface-geozones.md#geozones-public).
 
{% cut "Fields that cannot be used in presets" %}

#|
|| **Preset type** | **Field** ||
|| `depot` |
 - `address`
- `description`
- `id`
- `point`
- `ref`
- `title` ||
|| `location` |
- `address`
- `client_id`
- `comments`
- `delivery_to`
- `delivery_to_any`
- `depot_id`
`description`
- `id`
- `phone`
- `pickup_from_any`
- `point`
- `ref`
- `title`
- `type` ||
|| `vehicle` |
- `depot_id`
- `ending_depot_id`
- `finish_at`
- `fixed_planned_route`
- `global_proximity_attraction_point`
- `id`
- `imei`
- `fixed_work_breaks`
- `middle_depot_id`
- `phone`
- `planned_route`
- `ref`
- `shifts`
- `start_at`
- `starting_depot_id`
- `visited_locations` ||
|| `vehicle-shift` |
- `id` ||
|| `options` |
- `date`
- `location_groups` ||
|#

{% endcut %}

You can use the created presets to implement various scenarios and planning strategies. For more information, see [Using presets](https://docs.routeq.com/doc/en/vrp/presets.md).

## Copying a public preset {#presets-public-copy}

You cannot edit public presets. If you want to change the settings of a public preset, save a copy as a private preset and make the changes to that file.

**_Method 1_**

1. Under **Settings** → **Presets**, click **Private**.
1. Click **Add preset**.
1. Select a preset type, enter a preset name, and provide a description (optional). The name must be unique within the company, and it cannot start with `public_` or contain a comma.
1. At the bottom, click **Copy public preset** to display a list of public presets of the selected type.
1. Select a preset, and its contents will be copied to the edit window.
1. Edit the settings and click **Save**.

**_Method 2_**

1. Under **Settings** → **Presets**, click **Public**.
1. Open the preset you want to copy.
1. Click **Make personal copy of public preset**.
1. Change the preset name and description (optional). You can't change the preset type.
1. Edit the settings and click **Save**.

## Editing and deleting a preset {#presets-editing}

You can only edit your own presets that are available to your company. Only the latest (current) version is stored for each preset.

To edit a preset, click its name. In edit mode, you can change the name, description, and contents of the preset.

<svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="bb-ui-button__icon bb-ui-button__icon_left bb-ui-button__icon_mini"><path d="M7 1h1a6 6 0 006 6v1a6 6 0 00-6 6H7a6 6 0 00-6-6V7a6 6 0 006-6zM19 7h1a4 4 0 004 4v1a4 4 0 00-4 4h-1a4 4 0 00-4-4v-1a4 4 0 004-4zM16 18a3 3 0 01-3-3h-1a3 3 0 01-3 3v1a3 3 0 013 3h1a3 3 0 013-3v-1z" fill="#07F"/></svg>: Beautify code.

![](./_images/preset-edit.png)

You can remove a preset from the list or in edit mode.

**_Removing from the list_**

1. Hover the mouse over the line with the preset.
1. Click <svg width="12" height="14" viewBox="0 0 12 14" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M5.22076 0C4.79033 0 4.40819 0.27543 4.27208 0.683772L3.83333 2H2C0.895431 2 0 2.89543 0 4H12C12 2.89543 11.1046 2 10 2H5L7.85 1.05L7.72792 0.683772C7.59181 0.27543 7.20967 0 6.77924 0H5.22076Z" fill="#FF6666"/><path d="M10.8182 5H1.18182L1.91732 13.0905C1.96415 13.6056 2.39601 14 2.91321 14H9.08679C9.60399 14 10.0359 13.6056 10.0827 13.0905L10.8182 5Z" fill="#FF6666"/></svg> at the end of the line.
1. Confirm the action.

**_Removing in edit mode_**

1. Open the preset you want to remove.
1. Click **Delete**.
1. Confirm the action.


{% include [warehouse-feedback](_includes/feedback-81845556eeea.md) %}