Route4Me provides a Last Mile Routing API offering automated solutions for route planning and optimization, tailored for logistics-intensive businesses.
Route4Me provides a Last Mile Routing API offering automated solutions for route planning and optimization, tailored for logistics-intensive businesses. On Nagent, Route4me is exposed as a fully-configurable project management integration that any agent can call — 97 actions, and API key authentication. No code is required to wire Route4me into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Route4me to automate the kinds of tasks project management teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Route4me into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Every operation an agent can call against Route4me, with input parameters and output schema. Drop these into any step of an agent built in Helix.
ROUTE4ME_ADD_ORDER_CUSTOM_FIELDTool 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
Internal name/key for the custom field. Used as the identifier in API calls and data structures.
Type of the custom field. Common types include 'text', 'number', 'dropdown', 'checkbox', 'date'.
User-facing display label for the custom field shown in the UI.
Additional type-specific configuration for the custom field. Must contain at minimum a 'short_label' field with an abbreviated version of the label.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_ADD_ROUTE_NOTETool 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
The latitude of the device location when the note was created. Must be between -90 and 90.
The longitude of the device location when the note was created. Must be between -180 and 180.
The unique ID of the route to which the note should be added.
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.
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.
The content of the note to add. Maximum 1000 characters.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_CREATE_ADDRESSTool 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
The route Address Line 1 (street address).
The route Address Line 2 (apartment, suite, unit, etc.).
Last name of the contact.
Latitude coordinate (range: -90 to 90).
Longitude coordinate (range: -180 to 180).
First name of the contact.
ZIP/Postal code.
City name.
Email address.
State ID.
Phone number.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_CREATE_AVOIDANCE_ZONETool 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
Shape definition for the avoidance zone including type and geodetic data.
Name of the avoidance zone. Should be descriptive and unique.
Color of the zone in hexadecimal format (without '#'). Example: 'ff0000' for red, '00ff00' for green.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_CREATE_LOCATION_TYPETool 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
Name of the location type to create.
Whether this location type should be marked as a child type. Set to true if this type belongs under a parent type.
Whether this location type should be marked as a parent type. Set to true if this type can have child types.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_CREATE_MASTER_ROUTETool 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
Array of addresses for the route. Must include at least 2 addresses.
Route parameters including date, name, and optimization settings.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_CREATE_NOTETool 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
A string representing the custom note category name (e.g., 'To Do', 'Maintenance', 'Inspection').
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_CREATE_OPTIMIZATIONTool 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
List of addresses to optimize. Must include at least 2 addresses, with at least one marked as depot.
Optimization parameters including algorithm, route name, and configuration.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_CREATE_OPTIMIZATION_PROFILETool 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
Driver ID to be assigned to routes created with this profile.
Speed limit setting for route calculations.
Mark this profile as the default optimization profile.
Maximum volume capacity limit for routes.
Maximum weight capacity limit for routes.
Custom route name template to use for routes created with this profile.
Vehicle ID to be assigned to routes created with this profile.
Avoid toll roads when generating routes with this profile.
Break scheduling mode for routes.
Maximum distance constraint for routes in miles or kilometers.
The name of the optimization profile being created.
Avoid highways when generating routes with this profile.
Enable driver breaks in routes created with this profile.
Maximum route duration in seconds (minimum 1).
Speed cap unit.
Break duration in seconds for routes created with this profile.
Maximum number of stops allowed per route.
Optimization type for the profile.
Array of avoidance zone IDs to exclude from routes.
Ignore time window constraints when optimizing routes.
Enable avoidance zones for routes created with this profile.
Automatically append date to route names when using this profile.
Enable bundling settings for optimization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_CREATE_ORDER_CUSTOM_FIELDTool 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
Unique name of the custom field. This is used as an identifier and must be unique across all custom fields.
Type of the custom field that determines how it stores and displays data (e.g., text, checkbox, number).
User-facing label/display name for the custom field shown in the UI.
Additional metadata about the field type. Must contain at minimum a 'short_label' field with an abbreviated version of the label.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_CREATE_ORDERS_FROM_CONTACTSTool 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
Array of address book contact IDs to create orders from. Each ID must reference a valid contact in your address book.
Date for which orders should be scheduled in YYYY-MM-DD format (e.g., '2026-02-16').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_CREATE_TERRITORYTool 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
Shape definition for the territory including type and geodetic data.
Name of the territory. Should be descriptive and unique.
Color of the territory in hexadecimal format (without '#'). Example: 'ff0000' for red, '00ff00' for green.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_CREATE_VEHICLE_CAPACITY_PROFILETool 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
Name of the vehicle capacity profile. Should be descriptive and unique.
Maximum volume capacity of the vehicle. Must be non-negative.
Maximum weight capacity of the vehicle. Must be non-negative.
Maximum revenue capacity of the vehicle. Must be non-negative.
Maximum number of items the vehicle can carry. Must be non-negative.
Units for maximum volume (e.g., 'cu ft' for cubic feet, 'cu m' for cubic meters).
Units for maximum weight (e.g., 'lb' for pounds, 'kg' for kilograms).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DELETE_ADDRESSTool to delete an address from a route. Use when you need to remove a specific destination from an optimization problem or route.
Input parameters
The ID of the destination/address to be deleted.
The ID of the optimization problem from which the address should be removed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DELETE_ADDRESSESTool 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
Array of address IDs to delete from the address book. Each address ID must be a valid string identifier.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DELETE_AVOIDANCETool to delete an avoidance zone by territory_id. Use when you need to remove a specific avoidance zone from the routing system.
Input parameters
The unique 32-character MD5 identifier of the avoidance zone to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DELETE_CONFIGURATION_SETTINGTool to delete a member configuration setting by config_key. Use when you need to remove a specific configuration setting from the account.
Input parameters
The configuration key to delete (e.g., 'notification_template', 'service_provider').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DELETE_CURRENT_USERTool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DELETE_LOCATION_TYPETool 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
The unique identifier for the location type to be removed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DELETE_OPTIMIZATIONTool 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
An array of optimization problem IDs to delete. Each ID is a unique identifier for an optimization record.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DELETE_OPTIMIZATION_PROFILETool to delete an optimization profile by ID. Use when you need to remove a specific optimization profile record from the system.
Input parameters
The unique identifier of the optimization profile to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DELETE_ORDER_CUSTOM_FIELDTool to delete an order custom field by ID. Use when you need to remove a custom field definition from order records.
Input parameters
Unique identifier of the order custom field to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DELETE_ROUTE_V4Tool 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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DELETE_TERRITORYTool to delete a territory by territory_id. Use when you need to remove a specific territory from the system.
Input parameters
The unique 32-character MD5 identifier of the territory to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DELETE_VEHICLE_CAPACITY_PROFILE_BY_IDTool to delete a vehicle capacity profile by ID. Use when you need to remove a specific vehicle capacity profile from the system.
Input parameters
Vehicle Capacity Profile ID to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DISPATCH_ROUTESTool 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
Route ID or array of route IDs to filter. If provided, only routes matching these IDs will be affected.
Member ID to filter routes. If provided, only routes assigned to this member will be affected.
Vehicle ID or array of vehicle IDs to filter. If provided, only routes assigned to these vehicles will be affected.
Array of route status strings to filter. If provided, only routes with these statuses will be affected.
Array of date strings to filter by schedule date. If provided, only routes scheduled on these dates will be affected.
Sets the approved_for_execution flag for matched routes. Set to true to approve routes for execution, false to revoke approval.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DISPLAY_DATATABLE_CONFIGTool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_DUPLICATE_ROUTESTool 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
Array of route IDs that need to be duplicated. Each route will be cloned with a new unique ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_FIND_ADDRESSTool 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
The unique ID of the address to retrieve from the address book.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GEOCODE_ADDRESSTool 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
Response format. Only 'json' is supported. Default: json.
The address to geocode (minimum 3 characters).
If true, bypasses the cache and forces a fresh geocoding request. Default: true.
Quality level for geocoding results (1-5). Higher values provide more precise results.
If true, returns curbside coordinates for the address.
If true, returns detailed geocoding information.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GEOCODE_ADDRESS_BODYTool 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
Latitude for proximity bias. Used to influence geocoding results based on location.
Longitude for proximity bias. Used to influence geocoding results based on location.
Response format. Only 'json' is supported. Default: json.
The location to geocode (minimum 3 characters).
If true, bypass cache and fetch fresh geocoding data. Default: true.
Quality level for geocoding accuracy (1-5). Higher values may provide more precise results.
If true, enable curbside coordinate retrieval for the address.
If true, retrieve detailed geocoding results with additional metadata.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GEOCODE_ADDRESSESTool 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
Latitude coordinate for reference location (range: -90 to 90).
Longitude coordinate for reference location (range: -180 to 180).
Response format: json or xml. Default: json.
Device latitude coordinate (range: -90 to 90).
Device longitude coordinate (range: -180 to 180).
If true, bypasses the cache and forces a fresh geocoding request. Default: true.
Quality level for geocoding results (1-5). Higher values provide more precise results.
If true, returns curbside coordinates for the addresses.
If true, returns detailed geocoding information.
User latitude coordinate (range: -90 to 90).
User longitude coordinate (range: -180 to 180).
Array of address strings to geocode.
Device identifier for tracking purposes.
If true, disables filters in geocoding process.
Device type (e.g., 'web', 'mobile'). Default: web.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GEOCODE_ADDRESS_FORWARDTool 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
Reference latitude for proximity bias. Used to influence geocoding results based on location.
Reference longitude for proximity bias. Used to influence geocoding results based on location.
Response format. Only 'json' is supported.
The address to geocode (minimum 3 characters).
Device latitude at the time of the request.
Device longitude at the time of the request.
If true, bypass cache and fetch fresh geocoding data. Default: true.
Quality level for geocoding accuracy (1-5). Higher values provide more precise results.
If true, enable curbside coordinate retrieval for the address.
If true, return detailed geocoding results with additional metadata.
User latitude coordinate.
User longitude coordinate.
MD5 device identifier for tracking purposes.
If true, bypass filtering in geocoding process.
Device type. Default: web.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_ACTIVITYTool 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
Maximum number of activity records to return. Use for pagination.
Number of records to skip before returning results. Use with limit for pagination.
Filter activities by specific route ID. Returns only activities associated with this route.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_ADDRESSTool 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
Set to 1 to include notes associated with the destination. Default is 0 (exclude notes).
The ID of the route containing the address/destination.
The ID of the specific route destination/address within the route.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_ADDRESS_BOOK_GROUPSTool to retrieve address book groups from Route4Me. Use when you need to list all address book groups for filtering or organizing contacts.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_ADDRESSES_FROM_ADDRESSBOOKTool 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
Maximum number of address book contacts to return. Use for pagination.
Starting position for pagination. Use with limit to retrieve specific pages of results.
Comma-separated list of specific address IDs to retrieve (e.g., '8762599,8762600,8762601'). If provided, only these addresses will be returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_ASYNC_EXPORTTool 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
Time zone for the exported data.
Output format for tracking history export.
Flag to include custom data in the export.
End of the time range in Epoch time (Unix time) format.
Route ID to filter tracking history for a specific route.
Flag to include MMD (Member Metadata) in the export.
Device ID to filter tracking history.
Member ID to filter tracking history by specific member.
Start of the time range in Epoch time (Unix time) format.
If equal to 'custom', you can get the device's location history within the corresponding time range.
If true, only the last position of the corresponding device will be retrieved.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_AVOIDANCE2Tool 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
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.
Latitude coordinates of the corresponding area center. Used to filter territories by location.
Longitude coordinates of the corresponding area center. Used to filter territories by location.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_AVOIDANCE_BY_IDTool 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
The unique 32-character identifier of the avoidance zone to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_CLUSTERED_LOCATIONSTool 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
Filter configuration for location results.
Clustering configuration that determines how locations are grouped geographically.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_CURRENT_MEMBER_INFORMATIONTool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_FEEDTool 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
End of the Activity dates range (Unix timestamp).
If 'true', all Team Activities will be included into the search results.
Limit of the queried records number.
Search in the 'activity_message' field by the corresponding query phrase.
Start of the Activity dates range (Unix timestamp).
Start the search from the corresponding record number.
Route ID associated with the corresponding Activity(s).
Member ID associated with the corresponding Activity(s).
Filter results by Activity type.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_LAST_SCHEDULED_ROUTE_MEMBERTool 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
The identifier of the team member whose most recent scheduled route should be retrieved.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_LOCATION_HEATMAPTool 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
Optional query string for text-based location search.
Filter object for narrowing down location results in the heatmap.
Clustering precision parameter controlling heatmap granularity. Range: 1-12. Higher values produce more granular clusters. Default is 5.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_LOCATION_SERVICETIME_HEATMAPTool 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
The unique ID of the contact to retrieve heatmap data for. Required if location_id is not provided.
The unique ID of the location to retrieve heatmap data for. Required if contact_id is not provided.
Number of trailing days for the heatmap data. Valid value: 30 (other values may return validation errors).
The metric type identifier for the heatmap data.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_LOCATION_TYPETool 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
The unique identifier for the location type to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_MEMBER_CONFIGURATION_SETTINGSTool 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
Filter by member configuration setting. Use this to retrieve specific configuration settings.
Filter by specific configuration key. Use this to retrieve a single configuration setting by its key name.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_NOTE_CUSTOM_TYPESTool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_OPTIMIZATION_PROFILETool 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
UUID identifier of the optimization profile to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_ROUTE_DESTINATION_BY_IDTool 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
Route Address ID to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_ROUTE_INFOTool 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
Set to true to include route notes and destination notes in the response.
Set to true to return original route data before any modifications.
The unique identifier of the route to retrieve. This is a 32-character hexadecimal string.
Member/user identifier to filter route data by specific member.
Set to 1 to include turn-by-turn directions in the response. Default is 0 (exclude directions).
Set to true to include device tracking history data in the response.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_ROUTE_LISTTool 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
Page number for pagination. Must be at least 1.
Filtering parameters for route queries.
Field name to group results by (e.g., 'vehicle_id', 'member_id').
Array of \[field, direction\] pairs for sorting. Direction can be 'asc' or 'desc'. Example: \[\['route_id', 'asc'\], \['schedule_date', 'desc'\]\]
Number of results per page. Must be between 1 and 500.
IANA timezone string for date/time values in the response (e.g., 'America/New_York', 'UTC').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_ROUTE_SETTINGSTool 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
Route identifier as a 32-character hexadecimal string.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_TERRITORIES_WITH_LOCATION_COUNTSTool 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
Search query phrase to filter territories by name or other text fields.
Center point coordinates for circular filtering.
Filter territories by location status: 'all' for all locations, 'routed' for locations assigned to routes, or 'unrouted' for unassigned locations.
Search radius in meters from the center point. Default is 500 meters if not specified.
Filter by assignment status: true for assigned locations, false for unassigned locations.
Bounding box coordinates for filtering territories.
Array of customer IDs to filter territories by specific customers.
Array of geographic areas defined by circle, polygon, or rect types to filter territories.
Filter territories by member ID to show only locations assigned to a specific member/driver.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_TERRITORYTool to retrieve territory information by ID or get all territories. Use when you need details about geographic zones and their boundaries.
Input parameters
Set to 1 to include addresses within the territory in the response. Default is 0 (exclude addresses).
The unique identifier for a specific territory. If omitted, returns all territories.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_TRACKINGTool 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
Latitude coordinates of the device location.
Longitude coordinates of the device location.
Movement speed of the device (typically in mph or km/h).
Movement course/heading of the device in degrees (0-360).
Altitude/elevation of the device location.
ID of the route associated with this tracking data.
Unique identifier for the device (also known as 'device_guid').
Number of footsteps recorded by the device.
ID of the vehicle with the installed tracking device.
Application version number.
Type of device submitting tracking data.
Timezone of the device.
Application build number.
Timestamp from the device when the tracking data was captured.
Timezone offset from UTC in seconds or hours.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_TRACKING_HISTORY_EXPORTTool 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
Time zone for timestamp formatting in the export.
Output format for tracking history export.
Flag to control display of additional tracking data.
If true, the corresponding file will be downloaded as an attachment.
End of the time range in Epoch time (Unix timestamp) format. Required when time_period is 'custom'.
Route ID to filter tracking history. Retrieve history for a specific route.
Flag to control display of additional tracking metadata.
Device ID to filter tracking history. Retrieve history for a specific device.
Member ID to filter tracking history. Retrieve history for a specific team member.
Start of the time range in Epoch time (Unix timestamp) format. Required when time_period is 'custom'.
If equal to 'custom', you can get the device's location history within the corresponding time range specified by start_date and end_date.
If true, only the last position of the corresponding device will be retrieved.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_USER_BY_IDTool 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
The unique identifier of the sub-user to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_USER_LOCATIONSTool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_USER_MODIFICATION_HISTORYTool 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
The ID of the user whose modification history you want to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_USER_TEMPLATETool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_USER_V4Tool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_VEHICLETool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILE_AS_DATATABLETool 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
The requested page number. Must be at least 1.
Must contain a valid JSON with `search_query` attribute. E.g. `{"search_query":"1"}`
Order by the fields' names with their specific order direction. E.g. \[\[`max_volume`, `asc`\], \[`max_revenue`, `desc`\]\]
The number of vehicle capacity profiles per page.
Paginate all the data into one page only.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILE_BY_IDTool 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
Vehicle Capacity Profile ID. Must be a positive integer.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILE_PAGE_CONFIGTool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_GET_VEHICLE_CAPACITY_PROFILESTool 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
The requested page number for pagination. Must be at least 1.
Must contain a valid JSON string with search_query attribute for filtering profiles. Example: '{"search_query":"1"}'
The number of vehicle capacity profiles per page. Default is 100.
Paginate all the data into one page only. Set to true to retrieve all profiles in a single response.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_LIST_LOCATION_TYPESTool to retrieve location type definitions used in the address book system. Use when categorizing addresses or locations in Route4Me.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_LIST_OPTIMIZATION_PROFILESTool 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
Search term for filtering profiles by name or other attributes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_LIST_OPTIMIZATIONSTool 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
Limit of the queried records number.
Optimization state values.
Offset from the beginning of the queried records.
End of the time range (format: YYYY-MM-DD).
Start of the time range (format: YYYY-MM-DD).
An optimization ID. If specified, returns a single optimization; otherwise returns a list of all optimizations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_LIST_ORDER_CUSTOM_FIELDSTool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_LIST_ROUTE_DIRECTIONSTool 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
Maximum number of records to return. Must be between 1 and 300.
Pagination offset for results. Use to retrieve subsequent pages of data.
Route identifier as a 32-character hexadecimal string.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_LIST_TEAM_USERSTool 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.
Input parameters
Page number for pagination. Defaults to 1 if not specified.
Number of results to return per page. Common values: 10, 25, 50, 100.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_LIST_USERS_BY_IDSTool 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
Array of member IDs to retrieve. Minimum 1 member ID required.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_LIST_USERS_PAGINATEDTool 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
Page number for pagination. Defaults to 1 if not specified.
Search query to filter users by name, email, or other fields.
Sort field and direction as nested array. Format: \[\["field_name", "asc"\]\] or \[\["field_name", "desc"\]\].
Number of results to return per page. Common values: 10, 25, 50, 100.
Filter to show only drivers (members with driver role).
Filter users by specific optimization problem ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_LOOKUP_FOR_NEW_DESTINATIONTool 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
Latitude coordinate of the new destination (range: -90 to 90).
Longitude coordinate of the new destination (range: -180 to 180).
Enum for destination insert modes.
Enum for recommendation criteria.
Date the destination is scheduled for in YYYY-MM-DD format.
Maximum number of route recommendations to return. Default: 3.
Maximum allowed percentage increase in route distance or time. Routes exceeding this increase will be filtered out. Default: 500.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_MERGE_ROUTESTool 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
Array of route IDs to merge into the target route. These routes' destinations will be added to the target route.
The unique ID of the target route that will receive the merged destinations from other routes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_MOVE_ROUTETool to move a destination from one route to another. Use when reorganizing routes or reassigning stops between different routes.
Input parameters
The unique ID of the recipient route where the destination will be moved to.
The unique ID of the destination in the recipient route, after which the moving destination will be inserted.
The unique ID of the destination to be moved.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_PREVIEW_ROUTE_ASSIGNMENTTool 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
Page number for paginated results, minimum 1.
Filters for selecting routes to preview assignment.
Field name to group results by (e.g., 'member_id', 'vehicle_id', 'schedule_date').
Array format: \[field, direction\] for sorting results. Direction can be 'asc' or 'desc'.
Number of items per page, range 1-500.
IANA timezone string for date/time interpretation (e.g., 'America/New_York', 'UTC').
Array of route IDs to exclude from the assignment preview.
Assignment strategy for distributing routes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_RERUN_OPTIMIZATIONTool 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
List of addresses to update in the optimization.
Route parameters for optimization.
The optimization problem ID to re-optimize.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_REVERSE_GEOCODE_ADDRESSTool 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
Response format. Only 'json' is supported. Default: json.
If true, bypasses the cache and forces a fresh reverse geocoding request.
Quality level for reverse geocoding results (1-5). Higher values provide more precise results.
If true, returns detailed reverse geocoding information.
Latitude coordinate to reverse geocode (range: -90 to 90).
Longitude coordinate to reverse geocode (range: -180 to 180).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_SET_DESTINATION_STATUSTool to set or update the status of a route destination. Use after confirming deliveries to mark stops as visited or departed.
Input parameters
The desired status. Use `visited` to mark the destination as visited, or `departed` to mark as departed.
The unique ID of the route containing the destination.
The unique ID of the destination to update.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_SET_ROUTE_RATINGTool to set a rating for a route. Use when you need to record user feedback or satisfaction level for a completed route.
Input parameters
Rating value for the route. Must be between 1 and 5.
Route identifier as a 32-character hexadecimal string.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_SET_TRACKINGTool 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
Latitude coordinate of the current location.
Longitude coordinate of the current location.
Speed of the vehicle in miles per hour.
Transaction ID for this tracking update.
Direction/course heading in degrees (0-360).
Altitude value in meters.
The route identifier to track.
Member ID of the person being tracked.
Vehicle identifier associated with the route.
Application version sending the tracking data.
Device GUID identifier for the tracking device.
Type of device sending the tracking data (e.g., 'web', 'android_phone', 'iphone').
Device timestamp in ISO 8601 format or Unix timestamp.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_UPDATE_ADDRESSTool 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
Primary address line.
Secondary address line (apartment, suite, etc.).
Contact's last name.
The unique ID of the address book contact to update.
Contact's first name.
Latitude coordinate for the address.
Longitude coordinate for the address.
ZIP or postal code.
City name.
Service time at the location in seconds.
Custom name or alias for the contact.
Email address of the contact.
Group identifier for organizing contacts.
First time window end in seconds from midnight (e.g., 64800 for 6:00 PM).
State code (e.g., NY, CA).
First time window start in seconds from midnight (e.g., 28800 for 8:00 AM).
Custom key-value pairs for additional data.
Phone number of the contact.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_UPDATE_AVOIDANCETool 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
Updated geospatial data defining the shape and coordinates of the avoidance zone.
The unique 32-character MD5 identifier of the avoidance zone to update.
Updated name for the avoidance zone.
Updated hex color code for the territory (e.g., '0000ff' for blue, 'ff0000' for red).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_UPDATE_LOCATION_TYPETool 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
Name of the location type.
Description of the location type. Optional field to provide additional context about this type.
Whether this location type should be marked as a child type. Set to true if this type belongs under a parent type.
Whether this location type should be marked as a parent type. Set to true if this type can have child types.
The unique identifier for the location type to be updated.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_UPDATE_MEMBER_CONFIGURATION_SETTINGTool 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
Configuration key name to update (e.g., 'alert_elimination', 'notification_template', 'service_provider').
New value for the configuration setting.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_UPDATE_NOTE_CUSTOM_TYPETool 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
Custom Note Type ID to update. Use Get Note Custom Types action to retrieve available IDs.
The custom note type name. This should match the existing name of the note type being updated.
Array of custom values for the note type. These values replace the existing values for this custom note type.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_UPDATE_OPTIMIZATION_PROFILETool to update an existing optimization profile. Use when you need to modify routing preferences, constraints, or settings for route optimization.
Input parameters
Driver ID associated with this optimization profile.
Set as default profile. When true, this profile becomes the default optimization profile.
Vehicle ID associated with this optimization profile.
Avoid tolls in routing. When true, routes will avoid toll roads.
Maximum distance constraint for routes in the optimization profile (in miles or kilometers depending on account settings).
The name of the optimization profile.
Avoid highways in routing. When true, routes will avoid highway usage.
Maximum number of stops allowed in a route for this optimization profile.
Optimization type for routes: 'multi' for multi-stop optimization, 'single' for single destination, or 'off' to disable optimization.
The unique identifier of the optimization profile to update.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_UPDATE_ORDER_CUSTOM_FIELDTool 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
The unique identifier for the custom field being updated.
Updated type of the custom field (e.g., checkbox, text, dropdown).
Updated label for the custom field.
Additional metadata about the field type with configuration details.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_UPDATE_ROUTESTool 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
Array of route objects to update. Each object must contain route_id and update_data fields.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_UPDATE_ROUTE_SETTINGSTool 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
Optimization criterion for the route (e.g., Distance, Time, timeWithTraffic).
The unique identifier of the route to update. Route ID is a hex string with 32 characters.
Device type used for accessing the route (e.g., web, iphone, android).
Travel mode for the route (e.g., Driving, Walking, Bicycling, Trucking).
Distance measurement unit for the route. Use 'mi' for miles or 'km' for kilometers.
Vehicle capacity constraint for the route.
Maximum duration allowed for the route in seconds.
Maximum distance the vehicle can travel in miles.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_UPDATE_ROUTE_V4Tool 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
The ID of the route to update.
Object containing route update fields.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_UPDATE_TERRITORYTool 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
Geospatial data defining the territory shape.
The unique 32-character MD5 identifier of the territory to update.
Updated name for the territory.
Updated hex color code for the territory (e.g., '00ff00' for green, 'ff0000' for red).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ROUTE4ME_UPDATE_VEHICLE_CAPACITY_PROFILE_BY_IDTool 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
Vehicle Capacity Profile ID. The unique identifier of the profile to update.
Name of the vehicle capacity profile. Should be descriptive and unique.
Maximum volume capacity of the vehicle. Must be non-negative.
Maximum weight capacity of the vehicle. Must be non-negative.
Maximum revenue capacity of the vehicle. Must be non-negative.
Maximum number of items the vehicle can carry. Must be non-negative.
Units for maximum volume (e.g., 'cu ft' for cubic feet, 'cu m' for cubic meters).
Units for maximum weight (e.g., 'lb' for pounds, 'kg' for kilograms).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 67 agents privately built on Nagent that already use Route4me.
Build on Nagent
Connect Route4me to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Route4me, and click "Connect Now." You'll authenticate with an API key — Nagent handles credential storage and refresh automatically. Once connected, Route4me is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Route4me is connected, you configure its 97 actions directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Route4me steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Route4me event fires, the agent kicks off automatically.
Every Route4me action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Route4me ships with 97 pre-built project management actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Route4me together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Route4me-based workflows tailored to your business.