# Route4me

Route4Me provides a Last Mile Routing API offering automated solutions for route planning and optimization, tailored for logistics-intensive businesses.

- **Category:** project management
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 97
- **Triggers:** 0
- **Slug:** `ROUTE4ME`
- **Version:** 20260312_00

## Tools

### Add Order Custom Field

**Slug:** `ROUTE4ME_ADD_ORDER_CUSTOM_FIELD`

Tool to add a new custom field definition for orders. Use when you need to create additional data fields to capture order-specific information beyond the standard order properties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_custom_field_name` | string | Yes | Internal name/key for the custom field. Used as the identifier in API calls and data structures. |
| `order_custom_field_type` | string | Yes | Type of the custom field. Common types include 'text', 'number', 'dropdown', 'checkbox', 'date'. |
| `order_custom_field_label` | string | Yes | User-facing display label for the custom field shown in the UI. |
| `order_custom_field_type_info` | object | Yes | Additional type-specific configuration for the custom field. Must contain at minimum a 'short_label' field with an abbreviated version of the label. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Route Note

**Slug:** `ROUTE4ME_ADD_ROUTE_NOTE`

Tool to add a note to a route or address destination. Use when recording delivery status, customer feedback, or activity logs at specific stops.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dev_lat` | number | No | The latitude of the device location when the note was created. Must be between -90 and 90. |
| `dev_lng` | number | No | The longitude of the device location when the note was created. Must be between -180 and 180. |
| `route_id` | string | Yes | The unique ID of the route to which the note should be added. |
| `address_id` | integer | Yes | The unique ID of the address destination to which the note should be added. If not provided, the note will be added to the route itself. |
| `strUpdateType` | string ("pickup" | "dropoff" | "noanswer" | "notfound" | "paid" | "wrongdelivery" | "service_rendered" | "delivery" | "signature" | "refused" | "partial" | "damaged" | "missing" | "web" | "other") | Yes | The type/category of the note, indicating the activity or status. Use 'pickup' for pickup activities, 'dropoff' for deliveries, 'noanswer' if customer didn't answer, etc. |
| `strNoteContents` | string | Yes | The content of the note to add. Maximum 1000 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Address

**Slug:** `ROUTE4ME_CREATE_ADDRESS`

Tool to add a new address to the address book. Use when you need to create a new contact location for route planning or delivery management.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_1` | string | Yes | The route Address Line 1 (street address). |
| `address_2` | string | No | The route Address Line 2 (apartment, suite, unit, etc.). |
| `last_name` | string | No | Last name of the contact. |
| `cached_lat` | number | Yes | Latitude coordinate (range: -90 to 90). |
| `cached_lng` | number | Yes | Longitude coordinate (range: -180 to 180). |
| `first_name` | string | No | First name of the contact. |
| `address_zip` | string | No | ZIP/Postal code. |
| `address_city` | string | No | City name. |
| `address_email` | string | No | Email address. |
| `address_state_id` | string | No | State ID. |
| `address_phone_number` | string | No | Phone number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Avoidance Zone

**Slug:** `ROUTE4ME_CREATE_AVOIDANCE_ZONE`

Tool to create an avoidance zone with circular, rectangular, or polygon shape. Use when you need to define geographic regions that routes should avoid, such as construction areas, restricted zones, or traffic-prone regions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `territory` | object | Yes | Shape definition for the avoidance zone including type and geodetic data. |
| `territory_name` | string | Yes | Name of the avoidance zone. Should be descriptive and unique. |
| `territory_color` | string | No | Color of the zone in hexadecimal format (without '#'). Example: 'ff0000' for red, '00ff00' for green. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Location Type

**Slug:** `ROUTE4ME_CREATE_LOCATION_TYPE`

Tool to create a new location type in the address book. Use when you need to categorize locations with custom types before adding them to routes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the location type to create. |
| `is_child_type` | boolean | Yes | Whether this location type should be marked as a child type. Set to true if this type belongs under a parent type. |
| `is_parent_type` | boolean | Yes | Whether this location type should be marked as a parent type. Set to true if this type can have child types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Master Route

**Slug:** `ROUTE4ME_CREATE_MASTER_ROUTE`

Tool to create a new master route in Route4Me. Use when you need to create a route with waypoints, optimization settings, and delivery details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `addresses` | array | Yes | Array of addresses for the route. Must include at least 2 addresses. |
| `parameters` | object | Yes | Route parameters including date, name, and optimization settings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Custom Note Type

**Slug:** `ROUTE4ME_CREATE_NOTE`

Tool to create a new custom note type in Route4me. Use when you need to define a new category of notes with predefined selectable values for route destinations or activities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | A string representing the custom note category name (e.g., 'To Do', 'Maintenance', 'Inspection'). |
| `values` | array | Yes | An array of strings containing the predefined note options available for this custom type. These are the selectable values that will be available when using this note type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Route Optimization

**Slug:** `ROUTE4ME_CREATE_OPTIMIZATION`

Tool to create a new route optimization in Route4Me. Use when you need to optimize delivery routes, plan multi-stop trips, or generate efficient vehicle routing solutions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `addresses` | array | Yes | List of addresses to optimize. Must include at least 2 addresses, with at least one marked as depot. |
| `parameters` | object | Yes | Optimization parameters including algorithm, route name, and configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Optimization Profile

**Slug:** `ROUTE4ME_CREATE_OPTIMIZATION_PROFILE`

Tool to create a new optimization profile in Route4Me. Use when you need to store reusable optimization settings for route planning with specific configurations like driver assignment, vehicle settings, constraints, and preferences.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `driver_id` | integer | No | Driver ID to be assigned to routes created with this profile. |
| `speed_cap` | number | No | Speed limit setting for route calculations. |
| `is_default` | boolean | No | Mark this profile as the default optimization profile. |
| `max_volume` | number | No | Maximum volume capacity limit for routes. |
| `max_weight` | number | No | Maximum weight capacity limit for routes. |
| `route_name` | string | No | Custom route name template to use for routes created with this profile. |
| `vehicle_id` | string | No | Vehicle ID to be assigned to routes created with this profile. |
| `avoid_tolls` | boolean | No | Avoid toll roads when generating routes with this profile. |
| `breaks_mode` | integer | No | Break scheduling mode for routes. |
| `max_distance` | integer | No | Maximum distance constraint for routes in miles or kilometers. |
| `profile_name` | string | Yes | The name of the optimization profile being created. |
| `avoid_highways` | boolean | No | Avoid highways when generating routes with this profile. |
| `breaks_enabled` | boolean | No | Enable driver breaks in routes created with this profile. |
| `route_duration` | integer | No | Maximum route duration in seconds (minimum 1). |
| `speed_cap_unit` | string ("mph") | No | Speed cap unit. |
| `breaks_duration` | integer | No | Break duration in seconds for routes created with this profile. |
| `max_stops_count` | integer | No | Maximum number of stops allowed per route. |
| `optimization_type` | string ("off") | No | Optimization type for the profile. |
| `avoidance_zones_ids` | array | No | Array of avoidance zone IDs to exclude from routes. |
| `ignore_time_windows` | boolean | No | Ignore time window constraints when optimizing routes. |
| `avoidance_zones_enabled` | boolean | No | Enable avoidance zones for routes created with this profile. |
| `append_date_to_route_name` | boolean | No | Automatically append date to route names when using this profile. |
| `bundling_settings_is_enabled` | boolean | No | Enable bundling settings for optimization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order Custom Field

**Slug:** `ROUTE4ME_CREATE_ORDER_CUSTOM_FIELD`

Tool to create a new custom field definition for orders. Use when you need to define new custom data fields that can be attached to orders for tracking additional information beyond standard order fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_custom_field_name` | string | Yes | Unique name of the custom field. This is used as an identifier and must be unique across all custom fields. |
| `order_custom_field_type` | string | Yes | Type of the custom field that determines how it stores and displays data (e.g., text, checkbox, number). |
| `order_custom_field_label` | string | Yes | User-facing label/display name for the custom field shown in the UI. |
| `order_custom_field_type_info` | object | Yes | Additional metadata about the field type. Must contain at minimum a 'short_label' field with an abbreviated version of the label. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Orders from Contacts

**Slug:** `ROUTE4ME_CREATE_ORDERS_FROM_CONTACTS`

Tool to create orders from address book contacts. Use when you need to generate new orders from existing contacts for a specific delivery date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_ids` | array | Yes | Array of address book contact IDs to create orders from. Each ID must reference a valid contact in your address book. |
| `scheduled_for_date` | string | Yes | Date for which orders should be scheduled in YYYY-MM-DD format (e.g., '2026-02-16'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Territory

**Slug:** `ROUTE4ME_CREATE_TERRITORY`

Tool to create a new territory with circular, rectangular, or polygon shape. Use when you need to define geographic regions for route planning, service areas, or operational zones.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `territory` | object | Yes | Shape definition for the territory including type and geodetic data. |
| `territory_name` | string | Yes | Name of the territory. Should be descriptive and unique. |
| `territory_color` | string | No | Color of the territory in hexadecimal format (without '#'). Example: 'ff0000' for red, '00ff00' for green. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Vehicle Capacity Profile

**Slug:** `ROUTE4ME_CREATE_VEHICLE_CAPACITY_PROFILE`

Tool to create a vehicle capacity profile with weight, volume, item count, and revenue limits. Use when you need to define operational constraints for vehicles in route planning and fleet management.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the vehicle capacity profile. Should be descriptive and unique. |
| `max_volume` | number | No | Maximum volume capacity of the vehicle. Must be non-negative. |
| `max_weight` | number | No | Maximum weight capacity of the vehicle. Must be non-negative. |
| `max_revenue` | number | No | Maximum revenue capacity of the vehicle. Must be non-negative. |
| `max_items_number` | integer | No | Maximum number of items the vehicle can carry. Must be non-negative. |
| `max_volume_units` | string | No | Units for maximum volume (e.g., 'cu ft' for cubic feet, 'cu m' for cubic meters). |
| `max_weight_units` | string | No | Units for maximum weight (e.g., 'lb' for pounds, 'kg' for kilograms). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Address from Route

**Slug:** `ROUTE4ME_DELETE_ADDRESS`

Tool to delete an address from a route. Use when you need to remove a specific destination from an optimization problem or route.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `route_destination_id` | string | Yes | The ID of the destination/address to be deleted. |
| `optimization_problem_id` | string | Yes | The ID of the optimization problem from which the address should be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Addresses

**Slug:** `ROUTE4ME_DELETE_ADDRESSES`

Tool to delete addresses from the Route4Me address book. Use when you need to remove one or more addresses permanently from the address book.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_ids` | array | Yes | Array of address IDs to delete from the address book. Each address ID must be a valid string identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Avoidance Zone

**Slug:** `ROUTE4ME_DELETE_AVOIDANCE`

Tool to delete an avoidance zone by territory_id. Use when you need to remove a specific avoidance zone from the routing system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `territory_id` | string | Yes | The unique 32-character MD5 identifier of the avoidance zone to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Configuration Setting

**Slug:** `ROUTE4ME_DELETE_CONFIGURATION_SETTING`

Tool to delete a member configuration setting by config_key. Use when you need to remove a specific configuration setting from the account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `config_key` | string | Yes | The configuration key to delete (e.g., 'notification_template', 'service_provider'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Current User

**Slug:** `ROUTE4ME_DELETE_CURRENT_USER`

Tool to delete the current authenticated user account. Use when you need to permanently remove the current user's account including contact information, preferences, and account status. This action is irreversible.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Location Type

**Slug:** `ROUTE4ME_DELETE_LOCATION_TYPE`

Tool to delete a location type from the address book. Use when you need to remove a location type record with its associated details such as coordinates, address, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `location_type_id` | string | Yes | The unique identifier for the location type to be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Optimization

**Slug:** `ROUTE4ME_DELETE_OPTIMIZATION`

Tool to remove optimization problems from the Route4Me database. Use when you need to clean up or delete optimization records that are no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `optimization_problem_ids` | array | Yes | An array of optimization problem IDs to delete. Each ID is a unique identifier for an optimization record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Optimization Profile

**Slug:** `ROUTE4ME_DELETE_OPTIMIZATION_PROFILE`

Tool to delete an optimization profile by ID. Use when you need to remove a specific optimization profile record from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `optimization_profile_id` | string | Yes | The unique identifier of the optimization profile to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Order Custom Field

**Slug:** `ROUTE4ME_DELETE_ORDER_CUSTOM_FIELD`

Tool to delete an order custom field by ID. Use when you need to remove a custom field definition from order records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_custom_field_id` | integer | Yes | Unique identifier of the order custom field to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Route V4

**Slug:** `ROUTE4ME_DELETE_ROUTE_V4`

Tool to delete one or more routes by route_id. Use when you need to permanently remove routes from the system. Supports single or multiple route deletion via comma-separated route_ids.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `route_id` | string | Yes | The unique identifier of the route to be deleted. Can be a single route_id or comma-separated list of route_ids to delete multiple routes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Territory

**Slug:** `ROUTE4ME_DELETE_TERRITORY`

Tool to delete a territory by territory_id. Use when you need to remove a specific territory from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `territory_id` | string | Yes | The unique 32-character MD5 identifier of the territory to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Vehicle Capacity Profile by ID

**Slug:** `ROUTE4ME_DELETE_VEHICLE_CAPACITY_PROFILE_BY_ID`

Tool to delete a vehicle capacity profile by ID. Use when you need to remove a specific vehicle capacity profile from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Vehicle Capacity Profile ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Dispatch Routes

**Slug:** `ROUTE4ME_DISPATCH_ROUTES`

Tool to approve or revoke routes for execution in Route4Me. Use when you need to set approval status for routes based on filters like route ID, vehicle ID, member ID, route status, or schedule date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `route_id` | string | No | Route ID or array of route IDs to filter. If provided, only routes matching these IDs will be affected. |
| `member_id` | integer | No | Member ID to filter routes. If provided, only routes assigned to this member will be affected. |
| `vehicle_id` | string | No | Vehicle ID or array of vehicle IDs to filter. If provided, only routes assigned to these vehicles will be affected. |
| `route_status` | array | No | Array of route status strings to filter. If provided, only routes with these statuses will be affected. |
| `schedule_date` | array | No | Array of date strings to filter by schedule date. If provided, only routes scheduled on these dates will be affected. |
| `approved_for_execution` | boolean | Yes | Sets the approved_for_execution flag for matched routes. Set to true to approve routes for execution, false to revoke approval. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Display Datatable Config

**Slug:** `ROUTE4ME_DISPLAY_DATATABLE_CONFIG`

Tool to retrieve datatable configuration for vehicle capacity profiles. Use when you need to display vehicle capacity profiles in a datatable UI component with column definitions, filters, and action configurations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Duplicate Routes

**Slug:** `ROUTE4ME_DUPLICATE_ROUTES`

Tool to duplicate one or more existing routes. Use when you need to create copies of routes for similar deliveries or to use an existing route as a template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `duplicate_routes_id` | array | Yes | Array of route IDs that need to be duplicated. Each route will be cloned with a new unique ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Address

**Slug:** `ROUTE4ME_FIND_ADDRESS`

Tool to retrieve detailed information about a specific address from the Route4Me address book. Use when you need to look up address details, contact information, or service requirements by address ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_id` | integer | Yes | The unique ID of the address to retrieve from the address book. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Geocode Address

**Slug:** `ROUTE4ME_GEOCODE_ADDRESS`

Tool to geocode an address and obtain its coordinates. Use when you need latitude/longitude for an address string before creating routes or destinations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string | No | Response format. Only 'json' is supported. Default: json. |
| `address` | string | Yes | The address to geocode (minimum 3 characters). |
| `nocache` | boolean | No | If true, bypasses the cache and forces a fresh geocoding request. Default: true. |
| `quality` | integer | No | Quality level for geocoding results (1-5). Higher values provide more precise results. |
| `curbside` | boolean | No | If true, returns curbside coordinates for the address. |
| `detailed` | boolean | No | If true, returns detailed geocoding information. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Geocode Address (Body)

**Slug:** `ROUTE4ME_GEOCODE_ADDRESS_BODY`

Tool to geocode an address by sending a body payload with the address and options. Use when you need to convert an address string into geographic coordinates (latitude/longitude).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude for proximity bias. Used to influence geocoding results based on location. |
| `lng` | number | No | Longitude for proximity bias. Used to influence geocoding results based on location. |
| `format` | string | No | Response format: 'json' or 'xml'. Default: json. |
| `address` | string | Yes | The location to geocode (minimum 3 characters). |
| `nocache` | boolean | No | If true, bypass cache and fetch fresh geocoding data. Default: true. |
| `quality` | integer | No | Quality level for geocoding accuracy (1-5). Higher values may provide more precise results. |
| `curbside` | boolean | No | If true, enable curbside coordinate retrieval for the address. |
| `detailed` | boolean | No | If true, retrieve detailed geocoding results with additional metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Geocode Addresses

**Slug:** `ROUTE4ME_GEOCODE_ADDRESSES`

Tool to geocode multiple addresses in a single request. Use when you need latitude/longitude coordinates for multiple addresses at once before creating routes or destinations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude coordinate for reference location (range: -90 to 90). |
| `lng` | number | No | Longitude coordinate for reference location (range: -180 to 180). |
| `format` | string | No | Response format: json or xml. Default: json. |
| `dev_lat` | number | No | Device latitude coordinate (range: -90 to 90). |
| `dev_lng` | number | No | Device longitude coordinate (range: -180 to 180). |
| `nocache` | boolean | No | If true, bypasses the cache and forces a fresh geocoding request. Default: true. |
| `quality` | integer | No | Quality level for geocoding results (1-5). Higher values provide more precise results. |
| `curbside` | boolean | No | If true, returns curbside coordinates for the addresses. |
| `detailed` | boolean | No | If true, returns detailed geocoding information. |
| `user_lat` | number | No | User latitude coordinate (range: -90 to 90). |
| `user_lng` | number | No | User longitude coordinate (range: -180 to 180). |
| `addresses` | array | Yes | Array of address strings to geocode. |
| `device_id` | string | No | Device identifier for tracking purposes. |
| `no_filters` | boolean | No | If true, disables filters in geocoding process. |
| `device_type` | string | No | Device type (e.g., 'web', 'mobile'). Default: web. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Geocode Address Forward

**Slug:** `ROUTE4ME_GEOCODE_ADDRESS_FORWARD`

Tool to convert an address to geographic coordinates using forward geocoding. Use when you need latitude/longitude from an address string for route planning or location-based services.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Reference latitude for proximity bias. Used to influence geocoding results based on location. |
| `lng` | number | No | Reference longitude for proximity bias. Used to influence geocoding results based on location. |
| `format` | string | No | Response format. Only 'json' is supported. |
| `address` | string | Yes | The address to geocode (minimum 3 characters). |
| `dev_lat` | number | No | Device latitude at the time of the request. |
| `dev_lng` | number | No | Device longitude at the time of the request. |
| `nocache` | boolean | No | If true, bypass cache and fetch fresh geocoding data. Default: true. |
| `quality` | integer | No | Quality level for geocoding accuracy (1-5). Higher values provide more precise results. |
| `curbside` | boolean | No | If true, enable curbside coordinate retrieval for the address. |
| `detailed` | boolean | No | If true, return detailed geocoding results with additional metadata. |
| `user_lat` | number | No | User latitude coordinate. |
| `user_lng` | number | No | User longitude coordinate. |
| `device_id` | string | No | MD5 device identifier for tracking purposes. |
| `no_filters` | boolean | No | If true, bypass filtering in geocoding process. |
| `device_type` | string | No | Device type. Default: web. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Activity Feed

**Slug:** `ROUTE4ME_GET_ACTIVITY`

Tool to retrieve activities from the Route4Me activity feed with optional filtering and pagination. Use when you need to track changes, monitor team actions, or audit route modifications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of activity records to return. Use for pagination. |
| `offset` | integer | No | Number of records to skip before returning results. Use with limit for pagination. |
| `route_id` | string | No | Filter activities by specific route ID. Returns only activities associated with this route. |
| `activity_type` | string | No | Filter by activity type (e.g., 'member-created', 'delete-destination', 'mark-destination-visited', 'route-optimized', 'route-created'). If not specified, returns all activity types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Address

**Slug:** `ROUTE4ME_GET_ADDRESS`

Tool to get address/destination information from a route. Use when you need details about a specific stop including coordinates, status, contact information, and delivery data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | integer | No | Set to 1 to include notes associated with the destination. Default is 0 (exclude notes). |
| `route_id` | string | Yes | The ID of the route containing the address/destination. |
| `route_destination_id` | integer | Yes | The ID of the specific route destination/address within the route. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Address Book Groups

**Slug:** `ROUTE4ME_GET_ADDRESS_BOOK_GROUPS`

Tool to retrieve address book groups from Route4Me. Use when you need to list all address book groups for filtering or organizing contacts.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Addresses from Address Book

**Slug:** `ROUTE4ME_GET_ADDRESSES_FROM_ADDRESSBOOK`

Tool to retrieve addresses from the Route4Me address book. Use when you need to list contacts, search for specific addresses, or paginate through the address book. Supports filtering by address IDs and pagination with limit/offset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of address book contacts to return. Use for pagination. |
| `offset` | integer | No | Starting position for pagination. Use with limit to retrieve specific pages of results. |
| `address_id` | string | No | Comma-separated list of specific address IDs to retrieve (e.g., '8762599,8762600,8762601'). If provided, only these addresses will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Async Export Tracking History

**Slug:** `ROUTE4ME_GET_ASYNC_EXPORT`

Tool to save tracking history file via async export. Use when you need to export device tracking data in CSV, JSON, or XML format. The operation is asynchronous and returns a job ID for tracking the export progress.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tz` | string | No | Time zone for the exported data. |
| `format` | string ("csv" | "json" | "xml") | No | Output format for tracking history export. |
| `show_cd` | boolean | No | Flag to include custom data in the export. |
| `end_date` | integer | No | End of the time range in Epoch time (Unix time) format. |
| `route_id` | string | No | Route ID to filter tracking history for a specific route. |
| `show_mmd` | boolean | No | Flag to include MMD (Member Metadata) in the export. |
| `device_id` | string | No | Device ID to filter tracking history. |
| `member_id` | integer | No | Member ID to filter tracking history by specific member. |
| `start_date` | integer | No | Start of the time range in Epoch time (Unix time) format. |
| `time_period` | string | No | If equal to 'custom', you can get the device's location history within the corresponding time range. |
| `last_position` | boolean | No | If true, only the last position of the corresponding device will be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Territories (Avoidance Zones v5)

**Slug:** `ROUTE4ME_GET_AVOIDANCE2`

Tool to retrieve all avoidance zones (territories) using API v5.0. Use when you need to view existing territories for route planning, optionally filtered by geographic location and distance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `distance` | number | No | Area distance (radius of the area) in meters. Used with position_lat and position_lng to filter territories within this radius. Default is 1000 meters. |
| `position_lat` | number | No | Latitude coordinates of the corresponding area center. Used to filter territories by location. |
| `position_lng` | number | No | Longitude coordinates of the corresponding area center. Used to filter territories by location. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Avoidance Zone By ID

**Slug:** `ROUTE4ME_GET_AVOIDANCE_BY_ID`

Tool to retrieve a specific avoidance zone by its territory ID. Use when you need detailed information about a particular avoidance zone for route planning or validation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `territory_id` | string | Yes | The unique 32-character identifier of the avoidance zone to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Clustered Locations

**Slug:** `ROUTE4ME_GET_CLUSTERED_LOCATIONS`

Tool to retrieve locations grouped by geographic proximity using geohash clustering. Use when you need to view locations organized by area or analyze spatial distribution of address book entries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | object | No | Filter configuration for location results. |
| `clustering` | object | No | Clustering configuration that determines how locations are grouped geographically. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current Member Information

**Slug:** `ROUTE4ME_GET_CURRENT_MEMBER_INFORMATION`

Tool to retrieve the current authenticated member's information. Use when you need to get details about the logged-in user including contact information, preferences, permissions, and account status.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Activity Feed

**Slug:** `ROUTE4ME_GET_FEED`

Tool to retrieve all activities from the Route4Me activity feed. Use when you need to view activity history, track changes to routes, or monitor team member actions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | integer | No | End of the Activity dates range (Unix timestamp). |
| `team` | boolean | No | If 'true', all Team Activities will be included into the search results. |
| `limit` | integer | No | Limit of the queried records number. |
| `query` | string | No | Search in the 'activity_message' field by the corresponding query phrase. |
| `start` | integer | No | Start of the Activity dates range (Unix timestamp). |
| `offset` | integer | No | Start the search from the corresponding record number. |
| `route_id` | string | No | Route ID associated with the corresponding Activity(s). |
| `member_id` | integer | No | Member ID associated with the corresponding Activity(s). |
| `activity_type` | string | No | Filter results by Activity type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Last Scheduled Route for Member

**Slug:** `ROUTE4ME_GET_LAST_SCHEDULED_ROUTE_MEMBER`

Tool to retrieve the most recently scheduled route for a specific member as of today. Use when you need route details including waypoints, optimization settings, and delivery metrics for a team member.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `member_id` | string | Yes | The identifier of the team member whose most recent scheduled route should be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Location Heatmap

**Slug:** `ROUTE4ME_GET_LOCATION_HEATMAP`

Tool to retrieve a heat map of location clusters from the address book. Use when visualizing location density or analyzing geographic distribution of stops.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Optional query string for text-based location search. |
| `filter` | object | No | Filter object for narrowing down location results in the heatmap. |
| `precision` | integer | No | Clustering precision parameter controlling heatmap granularity. Range: 1-12. Higher values produce more granular clusters. Default is 5. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Location Service-Time Heatmap

**Slug:** `ROUTE4ME_GET_LOCATION_SERVICETIME_HEATMAP`

Tool to retrieve location service-time heatmap data for address book locations. Use when analyzing historical service times and performance metrics for specific locations over a trailing 30-day period.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | No | The unique ID of the contact to retrieve heatmap data for. Required if location_id is not provided. |
| `location_id` | integer | No | The unique ID of the location to retrieve heatmap data for. Required if contact_id is not provided. |
| `trailing_days` | integer | Yes | Number of trailing days for the heatmap data. Valid value: 30 (other values may return validation errors). |
| `metric_type_id` | integer | Yes | The metric type identifier for the heatmap data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Location Type

**Slug:** `ROUTE4ME_GET_LOCATION_TYPE`

Tool to get location type details by ID. Use when you need to retrieve specific information about a location type in the address book.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `location_type_id` | string | Yes | The unique identifier for the location type to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Member Configuration Settings

**Slug:** `ROUTE4ME_GET_MEMBER_CONFIGURATION_SETTINGS`

Tool to get member configuration settings with optional filtering. Use when you need to retrieve specific configuration settings by mcs or config_key parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mcs` | string | No | Filter by member configuration setting. Use this to retrieve specific configuration settings. |
| `config_key` | string | No | Filter by specific configuration key. Use this to retrieve a single configuration setting by its key name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Note Custom Types

**Slug:** `ROUTE4ME_GET_NOTE_CUSTOM_TYPES`

Tool to retrieve all custom note types configured for the account. Use when you need to view available note classification options before adding notes to routes or addresses.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Optimization Profile

**Slug:** `ROUTE4ME_GET_OPTIMIZATION_PROFILE`

Tool to retrieve detailed information about an optimization profile by its unique identifier. Use when you need to view the configuration settings, constraints, and optimization parameters of a specific profile before creating or planning routes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `optimization_profile_id` | string | Yes | UUID identifier of the optimization profile to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Route Destination By ID

**Slug:** `ROUTE4ME_GET_ROUTE_DESTINATION_BY_ID`

Tool to get a route address/destination by its ID. Use when you need detailed information about a specific route stop including location, status, customer details, and delivery data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Id` | integer | Yes | Route Address ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Route Info

**Slug:** `ROUTE4ME_GET_ROUTE_INFO`

Tool to get detailed route information by route ID. Use when you need comprehensive details about a specific route including waypoints, optimization settings, delivery details, and turn-by-turn directions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | boolean | No | Set to true to include route notes and destination notes in the response. |
| `original` | boolean | No | Set to true to return original route data before any modifications. |
| `route_id` | string | Yes | The unique identifier of the route to retrieve. This is a 32-character hexadecimal string. |
| `member_id` | integer | No | Member/user identifier to filter route data by specific member. |
| `directions` | integer | No | Set to 1 to include turn-by-turn directions in the response. Default is 0 (exclude directions). |
| `device_tracking_history` | boolean | No | Set to true to include device tracking history data in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Route List

**Slug:** `ROUTE4ME_GET_ROUTE_LIST`

Tool to retrieve a list of routes with filtering and pagination. Returns detailed route information including status, assignments, destinations, distances, and delivery metrics. Use when you need to query routes by various criteria such as date, vehicle, driver, or status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be at least 1. |
| `filters` | object | No | Filtering parameters for route queries. |
| `group_by` | string | No | Field name to group results by (e.g., 'vehicle_id', 'member_id'). |
| `order_by` | array | No | Array of [field, direction] pairs for sorting. Direction can be 'asc' or 'desc'. Example: [['route_id', 'asc'], ['schedule_date', 'desc']] |
| `per_page` | integer | No | Number of results per page. Must be between 1 and 500. |
| `timezone` | string | No | IANA timezone string for date/time values in the response (e.g., 'America/New_York', 'UTC'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Route Settings

**Slug:** `ROUTE4ME_GET_ROUTE_SETTINGS`

Tool to get route settings with detailed information including waypoints, optimization settings, and delivery details. Use when you need comprehensive configuration data for a specific route including all stops, delivery parameters, and optimization settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `route_id` | string | Yes | Route identifier as a 32-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Territories with Location Counts

**Slug:** `ROUTE4ME_GET_TERRITORIES_WITH_LOCATION_COUNTS`

Tool to retrieve territories with location counts for geographic analysis. Use when you need to analyze address distribution across territories or understand coverage areas.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Search query phrase to filter territories by name or other text fields. |
| `center` | object | No | Center point coordinates for circular filtering. |
| `display` | string | No | Filter territories by location status: 'all' for all locations, 'routed' for locations assigned to routes, or 'unrouted' for unassigned locations. |
| `distance` | number | No | Search radius in meters from the center point. Default is 500 meters if not specified. |
| `is_assigned` | boolean | No | Filter by assignment status: true for assigned locations, false for unassigned locations. |
| `bounding_box` | object | No | Bounding box coordinates for filtering territories. |
| `customer_ids` | array | No | Array of customer IDs to filter territories by specific customers. |
| `selected_areas` | array | No | Array of geographic areas defined by circle, polygon, or rect types to filter territories. |
| `assigned_member_id` | integer | No | Filter territories by member ID to show only locations assigned to a specific member/driver. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Territory

**Slug:** `ROUTE4ME_GET_TERRITORY`

Tool to retrieve territory information by ID or get all territories. Use when you need details about geographic zones and their boundaries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `addresses` | integer | No | Set to 1 to include addresses within the territory in the response. Default is 0 (exclude addresses). |
| `territory_id` | string | No | The unique identifier for a specific territory. If omitted, returns all territories. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Device Tracking Data

**Slug:** `ROUTE4ME_GET_TRACKING`

Tool to submit device GPS tracking information to Route4Me. Use when you need to send location updates from a mobile device or tracking unit to the Route4Me platform.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | Yes | Latitude coordinates of the device location. |
| `lng` | number | Yes | Longitude coordinates of the device location. |
| `speed` | number | No | Movement speed of the device (typically in mph or km/h). |
| `course` | number | No | Movement course/heading of the device in degrees (0-360). |
| `altitude` | number | No | Altitude/elevation of the device location. |
| `route_id` | string | No | ID of the route associated with this tracking data. |
| `device_id` | string | Yes | Unique identifier for the device (also known as 'device_guid'). |
| `footsteps` | number | No | Number of footsteps recorded by the device. |
| `vehicle_id` | string | No | ID of the vehicle with the installed tracking device. |
| `app_version` | string | Yes | Application version number. |
| `device_type` | string ("android" | "android_phone" | "android_tablet" | "iphone" | "ipad") | Yes | Type of device submitting tracking data. |
| `device_timezone` | string | No | Timezone of the device. |
| `app_build_number` | string | Yes | Application build number. |
| `device_timestamp` | string | No | Timestamp from the device when the tracking data was captured. |
| `device_timezone_offset` | string | No | Timezone offset from UTC in seconds or hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tracking History Export

**Slug:** `ROUTE4ME_GET_TRACKING_HISTORY_EXPORT`

Tool to export tracking history file from Route4Me. Use when you need to retrieve device location history for analysis, reporting, or compliance purposes. Supports filtering by device, member, route, and time range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tz` | string | No | Time zone for timestamp formatting in the export. |
| `format` | string ("csv" | "json" | "xml") | No | Output format for tracking history export. |
| `show_cd` | boolean | No | Flag to control display of additional tracking data. |
| `download` | boolean | No | If true, the corresponding file will be downloaded as an attachment. |
| `end_date` | integer | No | End of the time range in Epoch time (Unix timestamp) format. Required when time_period is 'custom'. |
| `route_id` | string | No | Route ID to filter tracking history. Retrieve history for a specific route. |
| `show_mmd` | boolean | No | Flag to control display of additional tracking metadata. |
| `device_id` | string | No | Device ID to filter tracking history. Retrieve history for a specific device. |
| `member_id` | integer | No | Member ID to filter tracking history. Retrieve history for a specific team member. |
| `start_date` | integer | No | Start of the time range in Epoch time (Unix timestamp) format. Required when time_period is 'custom'. |
| `time_period` | string | No | If equal to 'custom', you can get the device's location history within the corresponding time range specified by start_date and end_date. |
| `last_position` | boolean | No | If true, only the last position of the corresponding device will be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User By ID

**Slug:** `ROUTE4ME_GET_USER_BY_ID`

Tool to retrieve a sub-user by their unique ID. Use when you need detailed information about a specific team member including their permissions, settings, and profile data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | integer | Yes | The unique identifier of the sub-user to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Locations

**Slug:** `ROUTE4ME_GET_USER_LOCATIONS`

Tool to view locations of all users/drivers in real-time. Use when you need to track where drivers are currently located or monitor their movement.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Modification History

**Slug:** `ROUTE4ME_GET_USER_MODIFICATION_HISTORY`

Tool to get user modification history from Route4Me. Returns detailed audit trail of changes made to a user's account including field modifications, timestamps, and who initiated the changes. Use when you need to track user account changes or audit user information updates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `member_id` | integer | Yes | The ID of the user whose modification history you want to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Template

**Slug:** `ROUTE4ME_GET_USER_TEMPLATE`

Tool to retrieve the template of a sub-user with detailed information including contact information, preferences, and account status. Use when you need to get the user template structure or default user configuration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Information (v4)

**Slug:** `ROUTE4ME_GET_USER_V4`

Tool to retrieve authenticated user information in v4 format. Use when you need to get details about the currently authenticated user including member ID, email, name, account type, and preferences.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vehicles

**Slug:** `ROUTE4ME_GET_VEHICLE`

Tool to retrieve details of vehicles in the organization. Use when you need the full list of vehicles before planning routes or auditing vehicle capacities.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vehicle Capacity Profile As Datatable

**Slug:** `ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILE_AS_DATATABLE`

Tool to retrieve vehicle capacity profiles in datatable format with pagination. Use when you need to view capacity profiles for vehicles including weight, volume, revenue, and items limits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The requested page number. Must be at least 1. |
| `filters` | string | No | Must contain a valid JSON with `search_query` attribute. E.g. `{"search_query":"1"}` |
| `order_by` | array | No | Order by the fields' names with their specific order direction. E.g. [[`max_volume`, `asc`], [`max_revenue`, `desc`]] |
| `per_page` | integer | No | The number of vehicle capacity profiles per page. |
| `merge_pages` | boolean | No | Paginate all the data into one page only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vehicle Capacity Profile by ID

**Slug:** `ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILE_BY_ID`

Tool to retrieve a specific vehicle capacity profile by its ID. Use when you need details of a particular capacity profile for route planning or vehicle configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Vehicle Capacity Profile ID. Must be a positive integer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vehicle Capacity Profile Page Config

**Slug:** `ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILE_PAGE_CONFIG`

Tool to retrieve vehicle capacity profile page configuration including unit settings. Use when you need to understand available units for volume, weight, and revenue in vehicle capacity profiles.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vehicle Capacity Profiles

**Slug:** `ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILES`

Tool to retrieve vehicle capacity profiles with weight, volume, and item constraints. Use when you need to view available capacity profiles for route planning or vehicle assignment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The requested page number for pagination. Must be at least 1. |
| `filters` | string | No | Must contain a valid JSON string with search_query attribute for filtering profiles. Example: '{"search_query":"1"}' |
| `per_page` | integer | No | The number of vehicle capacity profiles per page. Default is 100. |
| `merge_pages` | boolean | No | Paginate all the data into one page only. Set to true to retrieve all profiles in a single response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Location Types

**Slug:** `ROUTE4ME_LIST_LOCATION_TYPES`

Tool to retrieve location type definitions used in the address book system. Use when categorizing addresses or locations in Route4Me.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Optimization Profiles

**Slug:** `ROUTE4ME_LIST_OPTIMIZATION_PROFILES`

Tool to retrieve optimization profiles with settings and configuration details. Use when you need to view available optimization profiles, check profile settings, or select a profile for route optimization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query_search` | string | No | Search term for filtering profiles by name or other attributes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Optimizations

**Slug:** `ROUTE4ME_LIST_OPTIMIZATIONS`

Tool to get a list of all optimizations or retrieve a single optimization by ID. Use when you need to view optimization details, check optimization status, or filter optimizations by state or date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit of the queried records number. |
| `state` | string ("initial" | "matrix_processing" | "optimizing" | "optimized" | "error" | "computing_directions" | "in_queue") | No | Optimization state values. |
| `offset` | integer | No | Offset from the beginning of the queried records. |
| `end_date` | string | No | End of the time range (format: YYYY-MM-DD). |
| `start_date` | string | No | Start of the time range (format: YYYY-MM-DD). |
| `optimization_problem_id` | string | No | An optimization ID. If specified, returns a single optimization; otherwise returns a list of all optimizations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Order Custom Fields

**Slug:** `ROUTE4ME_LIST_ORDER_CUSTOM_FIELDS`

Tool to retrieve all order custom field definitions from Route4Me v5.0 API. Use when you need to understand what custom fields are available for orders, including their types, labels, and configuration details.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Route Directions

**Slug:** `ROUTE4ME_LIST_ROUTE_DIRECTIONS`

Tool to get detailed route directions including turn-by-turn navigation information for each stop. Use when you need comprehensive direction details for a specific route including stop sequences, addresses, coordinates, and status information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records to return. Must be between 1 and 300. |
| `cursor` | integer | No | Pagination offset for results. Use to retrieve subsequent pages of data. |
| `route_id` | string | Yes | Route identifier as a 32-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Team Users

**Slug:** `ROUTE4ME_LIST_TEAM_USERS`

Tool to get the list of team members/users in the account. Use when you need to view all members, their roles, permissions, and contact information.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users By IDs

**Slug:** `ROUTE4ME_LIST_USERS_BY_IDS`

Tool to retrieve detailed information about team members by their member IDs. Use when you need to get specific user details for one or more members by their IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `member_ids` | array | Yes | Array of member IDs to retrieve. Minimum 1 member ID required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Team Users (Paginated)

**Slug:** `ROUTE4ME_LIST_USERS_PAGINATED`

Tool to get a paginated list of team members/users in the account. Use when you need to retrieve team members with pagination support, search filtering, or when dealing with large teams where retrieving all users at once is not practical.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Defaults to 1 if not specified. |
| `query` | string | No | Search query to filter users by name, email, or other fields. |
| `order_by` | array | No | Sort field and direction as nested array. Format: [["field_name", "asc"]] or [["field_name", "desc"]]. |
| `per_page` | integer | No | Number of results to return per page. Common values: 10, 25, 50, 100. |
| `drivers_only` | boolean | No | Filter to show only drivers (members with driver role). |
| `optimization_problem_id` | string | No | Filter users by specific optimization problem ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lookup For New Destination

**Slug:** `ROUTE4ME_LOOKUP_FOR_NEW_DESTINATION`

Tool to lookup optimal routes for inserting a new destination. Use when you need to find the best existing route(s) to add a new stop to, based on distance or time optimization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | Yes | Latitude coordinate of the new destination (range: -90 to 90). |
| `lng` | number | Yes | Longitude coordinate of the new destination (range: -180 to 180). |
| `insert_mode` | string ("optimal_anywhere" | "optimal_after_last_visited" | "end_of_route" | "beginning_of_route") | No | Enum for destination insert modes. |
| `recommend_by` | string ("distance" | "duration") | No | Enum for recommendation criteria. |
| `scheduled_for` | string | Yes | Date the destination is scheduled for in YYYY-MM-DD format. |
| `lookup_results_limit` | integer | No | Maximum number of route recommendations to return. Default: 3. |
| `max_increase_percent_allowed` | number | No | Maximum allowed percentage increase in route distance or time. Routes exceeding this increase will be filtered out. Default: 500. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Merge Routes

**Slug:** `ROUTE4ME_MERGE_ROUTES`

Tool to merge multiple routes into a single target route. Use when consolidating routes to optimize delivery operations or reduce the number of active routes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `route_ids` | array | Yes | Array of route IDs to merge into the target route. These routes' destinations will be added to the target route. |
| `target_route_id` | string | Yes | The unique ID of the target route that will receive the merged destinations from other routes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move Route Destination

**Slug:** `ROUTE4ME_MOVE_ROUTE`

Tool to move a destination from one route to another. Use when reorganizing routes or reassigning stops between different routes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_route_id` | string | Yes | The unique ID of the recipient route where the destination will be moved to. |
| `after_destination_id` | integer | Yes | The unique ID of the destination in the recipient route, after which the moving destination will be inserted. |
| `route_destination_id` | integer | Yes | The unique ID of the destination to be moved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview Route Assignment

**Slug:** `ROUTE4ME_PREVIEW_ROUTE_ASSIGNMENT`

Tool to generate a preview of route assignments based on filters, grouping, sorting, and assignment strategy without applying changes. Returns grouped results and subtotals for review before actual assignment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for paginated results, minimum 1. |
| `filters` | object | No | Filters for selecting routes to preview assignment. |
| `group_by` | string | No | Field name to group results by (e.g., 'member_id', 'vehicle_id', 'schedule_date'). |
| `order_by` | array | No | Array format: [field, direction] for sorting results. Direction can be 'asc' or 'desc'. |
| `per_page` | integer | No | Number of items per page, range 1-500. |
| `timezone` | string | No | IANA timezone string for date/time interpretation (e.g., 'America/New_York', 'UTC'). |
| `exclude_ids` | array | No | Array of route IDs to exclude from the assignment preview. |
| `assignment_strategy` | string ("single" | "round_robin" | "weighted_round_robin") | No | Assignment strategy for distributing routes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Re-run Optimization

**Slug:** `ROUTE4ME_RERUN_OPTIMIZATION`

Tool to re-optimize an existing optimization problem by updating route parameters and/or addresses. Use when you need to modify an existing route optimization with new parameters or address changes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `addresses` | array | No | List of addresses to update in the optimization. |
| `parameters` | object | No | Route parameters for optimization. |
| `optimization_problem_id` | string | Yes | The optimization problem ID to re-optimize. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reverse Geocode Address

**Slug:** `ROUTE4ME_REVERSE_GEOCODE_ADDRESS`

Tool to reverse geocode coordinates to obtain an address. Use when you need to convert latitude/longitude coordinates into a human-readable street address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string | No | Response format. Only 'json' is supported. Default: json. |
| `nocache` | boolean | No | If true, bypasses the cache and forces a fresh reverse geocoding request. |
| `quality` | integer | No | Quality level for reverse geocoding results (1-5). Higher values provide more precise results. |
| `detailed` | boolean | No | If true, returns detailed reverse geocoding information. |
| `latitude` | number | Yes | Latitude coordinate to reverse geocode (range: -90 to 90). |
| `longitude` | number | Yes | Longitude coordinate to reverse geocode (range: -180 to 180). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Destination Status

**Slug:** `ROUTE4ME_SET_DESTINATION_STATUS`

Tool to set or update the status of a route destination. Use after confirming deliveries to mark stops as visited or departed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("visited" | "departed") | Yes | The desired status. Use `visited` to mark the destination as visited, or `departed` to mark as departed. |
| `route_id` | string | Yes | The unique ID of the route containing the destination. |
| `route_destination_id` | integer | Yes | The unique ID of the destination to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Route Rating

**Slug:** `ROUTE4ME_SET_ROUTE_RATING`

Tool to set a rating for a route. Use when you need to record user feedback or satisfaction level for a completed route.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rating` | integer | Yes | Rating value for the route. Must be between 1 and 5. |
| `route_id` | string | Yes | Route identifier as a 32-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Route Tracking Data

**Slug:** `ROUTE4ME_SET_TRACKING`

Tool to insert tracking data for a route. Use when you need to update the real-time location and status of a vehicle or driver on a route.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | Yes | Latitude coordinate of the current location. |
| `lng` | number | Yes | Longitude coordinate of the current location. |
| `speed` | number | No | Speed of the vehicle in miles per hour. |
| `tx_id` | string | No | Transaction ID for this tracking update. |
| `course` | number | No | Direction/course heading in degrees (0-360). |
| `altitude` | number | No | Altitude value in meters. |
| `route_id` | string | Yes | The route identifier to track. |
| `member_id` | integer | No | Member ID of the person being tracked. |
| `vehicle_id` | string | No | Vehicle identifier associated with the route. |
| `app_version` | string | No | Application version sending the tracking data. |
| `device_guid` | string | No | Device GUID identifier for the tracking device. |
| `device_type` | string | No | Type of device sending the tracking data (e.g., 'web', 'android_phone', 'iphone'). |
| `device_timestamp` | string | No | Device timestamp in ISO 8601 format or Unix timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Address

**Slug:** `ROUTE4ME_UPDATE_ADDRESS`

Tool to update an existing address in the Route4Me address book. Use when you need to modify contact details, location information, or time windows for an address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_1` | string | No | Primary address line. |
| `address_2` | string | No | Secondary address line (apartment, suite, etc.). |
| `last_name` | string | No | Contact's last name. |
| `address_id` | integer | Yes | The unique ID of the address book contact to update. |
| `first_name` | string | No | Contact's first name. |
| `address_lat` | number | No | Latitude coordinate for the address. |
| `address_lng` | number | No | Longitude coordinate for the address. |
| `address_zip` | string | No | ZIP or postal code. |
| `address_city` | string | No | City name. |
| `service_time` | integer | No | Service time at the location in seconds. |
| `address_alias` | string | No | Custom name or alias for the contact. |
| `address_email` | string | No | Email address of the contact. |
| `address_group` | string | No | Group identifier for organizing contacts. |
| `time_window_end` | integer | No | First time window end in seconds from midnight (e.g., 64800 for 6:00 PM). |
| `address_state_id` | string | No | State code (e.g., NY, CA). |
| `time_window_start` | integer | No | First time window start in seconds from midnight (e.g., 28800 for 8:00 AM). |
| `address_custom_data` | object | No | Custom key-value pairs for additional data. |
| `address_phone_number` | string | No | Phone number of the contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Avoidance Zone

**Slug:** `ROUTE4ME_UPDATE_AVOIDANCE`

Tool to update an existing avoidance zone. Use when you need to modify the name, color, or geographic boundaries of an avoidance zone for route planning.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `territory` | object | Yes | Updated geospatial data defining the shape and coordinates of the avoidance zone. |
| `territory_id` | string | Yes | The unique 32-character MD5 identifier of the avoidance zone to update. |
| `territory_name` | string | Yes | Updated name for the avoidance zone. |
| `territory_color` | string | Yes | Updated hex color code for the territory (e.g., '0000ff' for blue, 'ff0000' for red). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Location Type

**Slug:** `ROUTE4ME_UPDATE_LOCATION_TYPE`

Tool to update an existing location type in the address book. Use when you need to modify location type details such as name, parent/child type status, or description.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the location type. |
| `description` | string | No | Description of the location type. Optional field to provide additional context about this type. |
| `is_child_type` | boolean | Yes | Whether this location type should be marked as a child type. Set to true if this type belongs under a parent type. |
| `is_parent_type` | boolean | Yes | Whether this location type should be marked as a parent type. Set to true if this type can have child types. |
| `location_type_id` | string | Yes | The unique identifier for the location type to be updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Member Configuration Setting

**Slug:** `ROUTE4ME_UPDATE_MEMBER_CONFIGURATION_SETTING`

Tool to update a member configuration setting. Use when you need to modify account-level configuration values such as notification preferences, feature flags, or service provider settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `config_key` | string | Yes | Configuration key name to update (e.g., 'alert_elimination', 'notification_template', 'service_provider'). |
| `config_value` | string | Yes | New value for the configuration setting. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Custom Note Type

**Slug:** `ROUTE4ME_UPDATE_NOTE_CUSTOM_TYPE`

Tool to update an existing custom note type in Route4Me. Use when you need to modify the name or values of a custom note type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Custom Note Type ID to update. Use Get Note Custom Types action to retrieve available IDs. |
| `note_custom_type` | string | Yes | The custom note type name. This should match the existing name of the note type being updated. |
| `note_custom_type_values` | array | Yes | Array of custom values for the note type. These values replace the existing values for this custom note type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Optimization Profile

**Slug:** `ROUTE4ME_UPDATE_OPTIMIZATION_PROFILE`

Tool to update an existing optimization profile. Use when you need to modify routing preferences, constraints, or settings for route optimization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `driver_id` | integer | No | Driver ID associated with this optimization profile. |
| `is_default` | boolean | No | Set as default profile. When true, this profile becomes the default optimization profile. |
| `vehicle_id` | string | No | Vehicle ID associated with this optimization profile. |
| `avoid_tolls` | boolean | No | Avoid tolls in routing. When true, routes will avoid toll roads. |
| `max_distance` | integer | No | Maximum distance constraint for routes in the optimization profile (in miles or kilometers depending on account settings). |
| `profile_name` | string | Yes | The name of the optimization profile. |
| `avoid_highways` | boolean | No | Avoid highways in routing. When true, routes will avoid highway usage. |
| `max_stops_count` | integer | No | Maximum number of stops allowed in a route for this optimization profile. |
| `optimization_type` | string | No | Optimization type for routes: 'multi' for multi-stop optimization, 'single' for single destination, or 'off' to disable optimization. |
| `optimization_profile_id` | string | Yes | The unique identifier of the optimization profile to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Order Custom Field

**Slug:** `ROUTE4ME_UPDATE_ORDER_CUSTOM_FIELD`

Tool to update an existing order custom field in Route4Me. Use when you need to modify the label, type, or configuration of a custom field for orders.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_custom_field_id` | integer | Yes | The unique identifier for the custom field being updated. |
| `order_custom_field_type` | string | Yes | Updated type of the custom field (e.g., checkbox, text, dropdown). |
| `order_custom_field_label` | string | Yes | Updated label for the custom field. |
| `order_custom_field_type_info` | object | Yes | Additional metadata about the field type with configuration details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Routes

**Slug:** `ROUTE4ME_UPDATE_ROUTES`

Tool to bulk update multiple routes in a single operation. Use when you need to update route names, optimization settings, duration constraints, or reassign multiple routes to team members efficiently.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `routes` | array | Yes | Array of route objects to update. Each object must contain route_id and update_data fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Route Settings

**Slug:** `ROUTE4ME_UPDATE_ROUTE_SETTINGS`

Tool to update route settings including optimization parameters, distance units, and device types. Use when you need to modify route configuration such as optimization criteria, distance measurement units, or device-specific settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `optimize` | string | No | Optimization criterion for the route (e.g., Distance, Time, timeWithTraffic). |
| `route_id` | string | Yes | The unique identifier of the route to update. Route ID is a hex string with 32 characters. |
| `device_type` | string | No | Device type used for accessing the route (e.g., web, iphone, android). |
| `travel_mode` | string | No | Travel mode for the route (e.g., Driving, Walking, Bicycling, Trucking). |
| `distance_unit` | string | No | Distance measurement unit for the route. Use 'mi' for miles or 'km' for kilometers. |
| `vehicle_capacity` | integer | No | Vehicle capacity constraint for the route. |
| `route_max_duration` | integer | No | Maximum duration allowed for the route in seconds. |
| `vehicle_max_distance_mi` | number | No | Maximum distance the vehicle can travel in miles. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Route V4

**Slug:** `ROUTE4ME_UPDATE_ROUTE_V4`

Tool to update route parameters and addresses in Route4Me. Use when you need to modify route name, optimization settings, duration constraints, or reassign routes to team members.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `route_id` | string | Yes | The ID of the route to update. |
| `parameters` | object | Yes | Object containing route update fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Territory

**Slug:** `ROUTE4ME_UPDATE_TERRITORY`

Tool to update an existing territory. Use when you need to modify the name, color, or geographic boundaries of a territory for route planning and organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `territory` | object | No | Geospatial data defining the territory shape. |
| `territory_id` | string | Yes | The unique 32-character MD5 identifier of the territory to update. |
| `territory_name` | string | No | Updated name for the territory. |
| `territory_color` | string | No | Updated hex color code for the territory (e.g., '00ff00' for green, 'ff0000' for red). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Vehicle Capacity Profile By ID

**Slug:** `ROUTE4ME_UPDATE_VEHICLE_CAPACITY_PROFILE_BY_ID`

Tool to update an existing vehicle capacity profile by ID. Use when you need to modify capacity constraints such as weight, volume, item count, or revenue limits for a specific vehicle profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Vehicle Capacity Profile ID. The unique identifier of the profile to update. |
| `name` | string | No | Name of the vehicle capacity profile. Should be descriptive and unique. |
| `max_volume` | number | No | Maximum volume capacity of the vehicle. Must be non-negative. |
| `max_weight` | number | No | Maximum weight capacity of the vehicle. Must be non-negative. |
| `max_revenue` | number | No | Maximum revenue capacity of the vehicle. Must be non-negative. |
| `max_items_number` | integer | No | Maximum number of items the vehicle can carry. Must be non-negative. |
| `max_volume_units` | string | No | Units for maximum volume (e.g., 'cu ft' for cubic feet, 'cu m' for cubic meters). |
| `max_weight_units` | string | No | Units for maximum weight (e.g., 'lb' for pounds, 'kg' for kilograms). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |