Skip to main content
Route4me logo
  • Category: project management
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 97
  • Triggers: 0
  • Slug: ROUTE4ME
  • Version: 20261101_00

Tools

Slug: 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

string
required
Internal name/key for the custom field. Used as the identifier in API calls and data structures.
string
required
Type of the custom field. Common types include ‘text’, ‘number’, ‘dropdown’, ‘checkbox’, ‘date’.
string
required
User-facing display label for the custom field shown in the UI.
object
required
Additional type-specific configuration for the custom field. Must contain at minimum a ‘short_label’ field with an abbreviated version of the label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_ADD_ROUTE_NOTEAdd a note to an address destination on a route. Use it to record delivery status, customer feedback, or activity at a specific stop.

Input Parameters

number
The latitude of the device location when the note was created. Must be between -90 and 90.
number
The longitude of the device location when the note was created. Must be between -180 and 180.
string
required
The unique ID of the route to which the note should be added.
integer
required
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.
string ("pickup" | "dropoff" | "noanswer" | "notfound" | "paid" | "wrongdelivery" | "service_rendered" | "delivery" | "signature" | "refused" | "partial" | "damaged" | "missing" | "web" | "other")
required
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.
string
required
The content of the note to add. Maximum 1000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The route Address Line 1 (street address).
string
The route Address Line 2 (apartment, suite, unit, etc.).
string
Last name of the contact.
number
required
Latitude coordinate (range: -90 to 90).
number
required
Longitude coordinate (range: -180 to 180).
string
First name of the contact.
string
ZIP/Postal code.
string
City name.
string
Email address.
string
State ID.
string
Phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Shape definition for the avoidance zone including type and geodetic data.
string
required
Name of the avoidance zone. Should be descriptive and unique.
string
Color of the zone in hexadecimal format (without ’#’). Example: ‘ff0000’ for red, ‘00ff00’ for green.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the location type to create.
boolean
required
Whether this location type should be marked as a child type. Set to true if this type belongs under a parent type.
boolean
required
Whether this location type should be marked as a parent type. Set to true if this type can have child types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
Array of addresses for the route. Must include at least 2 addresses.
object
required
Route parameters including date, name, and optimization settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A string representing the custom note category name (e.g., ‘To Do’, ‘Maintenance’, ‘Inspection’).
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of addresses to optimize. Must include at least 2 addresses, with at least one marked as depot.
object
required
Optimization parameters including algorithm, route name, and configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Driver ID to be assigned to routes created with this profile.
number
Speed limit setting for route calculations.
boolean
Mark this profile as the default optimization profile.
number
Maximum volume capacity limit for routes.
number
Maximum weight capacity limit for routes.
string
Custom route name template to use for routes created with this profile.
string
Vehicle ID to be assigned to routes created with this profile.
boolean
Avoid toll roads when generating routes with this profile.
integer
Break scheduling mode for routes.
integer
Maximum distance constraint for routes in miles or kilometers.
string
required
The name of the optimization profile being created.
boolean
Avoid highways when generating routes with this profile.
boolean
Enable driver breaks in routes created with this profile.
integer
Maximum route duration in seconds (minimum 1).
string ("mph")
Speed cap unit.
integer
Break duration in seconds for routes created with this profile.
integer
Maximum number of stops allowed per route.
string ("off")
Optimization type for the profile.
array
Array of avoidance zone IDs to exclude from routes.
boolean
Ignore time window constraints when optimizing routes.
boolean
Enable avoidance zones for routes created with this profile.
boolean
Automatically append date to route names when using this profile.
boolean
Enable bundling settings for optimization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
Array of address book contact IDs to create orders from. Each ID must reference a valid contact in your address book.
string
required
Date for which orders should be scheduled in YYYY-MM-DD format (e.g., ‘2026-02-16’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Shape definition for the territory including type and geodetic data.
string
required
Name of the territory. Should be descriptive and unique.
string
Color of the territory in hexadecimal format (without ’#’). Example: ‘ff0000’ for red, ‘00ff00’ for green.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the vehicle capacity profile. Should be descriptive and unique.
number
Maximum volume capacity of the vehicle. Must be non-negative.
number
Maximum weight capacity of the vehicle. Must be non-negative.
number
Maximum revenue capacity of the vehicle. Must be non-negative.
integer
Maximum number of items the vehicle can carry. Must be non-negative.
string
Units for maximum volume (e.g., ‘cu ft’ for cubic feet, ‘cu m’ for cubic meters).
string
Units for maximum weight (e.g., ‘lb’ for pounds, ‘kg’ for kilograms).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the destination/address to be deleted.
string
required
The ID of the optimization problem from which the address should be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
Array of address IDs to delete from the address book. Each address ID must be a valid string identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique 32-character MD5 identifier of the avoidance zone to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The configuration key to delete (e.g., ‘notification_template’, ‘service_provider’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_DELETE_LOCATION_TYPEDelete an address book location type by its ID. The returned status alone does not independently confirm that the location type was deleted.

Input Parameters

string
required
The unique identifier for the location type to be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_DELETE_OPTIMIZATIONDelete optimization problems by ID from the Route4Me database, for example to clean up records that are no longer needed. The reported removed count may reflect the number requested rather than the number actually deleted.

Input Parameters

array
required
An array of optimization problem IDs to delete. Each ID is a unique identifier for an optimization record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the optimization profile to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Unique identifier of the order custom field to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_DELETE_TERRITORYTool to delete a territory by territory_id. Use when you need to remove a specific territory from the system.

Input Parameters

string
required
The unique 32-character MD5 identifier of the territory to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Vehicle Capacity Profile ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Route ID or array of route IDs to filter. If provided, only routes matching these IDs will be affected.
integer
Member ID to filter routes. If provided, only routes assigned to this member will be affected.
string
Vehicle ID or array of vehicle IDs to filter. If provided, only routes assigned to these vehicles will be affected.
array
Array of route status strings to filter. If provided, only routes with these statuses will be affected.
array
Array of date strings to filter by schedule date. If provided, only routes scheduled on these dates will be affected.
boolean
required
Sets the approved_for_execution flag for matched routes. Set to true to approve routes for execution, false to revoke approval.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
Array of route IDs that need to be duplicated. Each route will be cloned with a new unique ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique ID of the address to retrieve from the address book.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Response format. Only ‘json’ is supported. Default: json.
string
required
The address to geocode (minimum 3 characters).
boolean
If true, bypasses the cache and forces a fresh geocoding request. Default: true.
integer
Quality level for geocoding results (1-5). Higher values provide more precise results.
boolean
If true, returns curbside coordinates for the address.
boolean
If true, returns detailed geocoding information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Latitude for proximity bias. Used to influence geocoding results based on location.
number
Longitude for proximity bias. Used to influence geocoding results based on location.
string
Response format. Only ‘json’ is supported. Default: json.
string
required
The location to geocode (minimum 3 characters).
boolean
If true, bypass cache and fetch fresh geocoding data. Default: true.
integer
Quality level for geocoding accuracy (1-5). Higher values may provide more precise results.
boolean
If true, enable curbside coordinate retrieval for the address.
boolean
If true, retrieve detailed geocoding results with additional metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Latitude coordinate for reference location (range: -90 to 90).
number
Longitude coordinate for reference location (range: -180 to 180).
string
Response format: json or xml. Default: json.
number
Device latitude coordinate (range: -90 to 90).
number
Device longitude coordinate (range: -180 to 180).
boolean
If true, bypasses the cache and forces a fresh geocoding request. Default: true.
integer
Quality level for geocoding results (1-5). Higher values provide more precise results.
boolean
If true, returns curbside coordinates for the addresses.
boolean
If true, returns detailed geocoding information.
number
User latitude coordinate (range: -90 to 90).
number
User longitude coordinate (range: -180 to 180).
array
required
Array of address strings to geocode.
string
Device identifier for tracking purposes.
boolean
If true, disables filters in geocoding process.
string
Device type (e.g., ‘web’, ‘mobile’). Default: web.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Reference latitude for proximity bias. Used to influence geocoding results based on location.
number
Reference longitude for proximity bias. Used to influence geocoding results based on location.
string
Response format. Only ‘json’ is supported.
string
required
The address to geocode (minimum 3 characters).
number
Device latitude at the time of the request.
number
Device longitude at the time of the request.
boolean
If true, bypass cache and fetch fresh geocoding data. Default: true.
integer
Quality level for geocoding accuracy (1-5). Higher values provide more precise results.
boolean
If true, enable curbside coordinate retrieval for the address.
boolean
If true, return detailed geocoding results with additional metadata.
number
User latitude coordinate.
number
User longitude coordinate.
string
MD5 device identifier for tracking purposes.
boolean
If true, bypass filtering in geocoding process.
string
Device type. Default: web.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of activity records to return. Use for pagination.
integer
Number of records to skip before returning results. Use with limit for pagination.
string
Filter activities by specific route ID. Returns only activities associated with this route.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Set to 1 to include notes associated with the destination. Default is 0 (exclude notes).
string
required
The ID of the route containing the address/destination.
integer
required
The ID of the specific route destination/address within the route.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of address book contacts to return. Use for pagination.
integer
Starting position for pagination. Use with limit to retrieve specific pages of results.
string
Comma-separated list of specific address IDs to retrieve (e.g., ‘8762599,8762600,8762601’). If provided, only these addresses will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_GET_ASYNC_EXPORTRequest an asynchronous export of device tracking history in CSV, JSON, or XML format. The response may contain export status or a job ID, or raw file content.

Input Parameters

string
Time zone for the exported data.
string ("csv" | "json" | "xml")
Output format for tracking history export.
boolean
Flag to include custom data in the export.
integer
End of the time range in Epoch time (Unix time) format.
string
Route ID to filter tracking history for a specific route.
boolean
Flag to include MMD (Member Metadata) in the export.
string
Device ID to filter tracking history.
integer
Member ID to filter tracking history by specific member.
integer
Start of the time range in Epoch time (Unix time) format.
string
If equal to ‘custom’, you can get the device’s location history within the corresponding time range.
boolean
If true, only the last position of the corresponding device will be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_GET_AVOIDANCE2Retrieve avoidance zones (territories) using the v4 API, optionally filtered by geographic location and distance for route planning.

Input Parameters

number
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.
number
Latitude coordinates of the corresponding area center. Used to filter territories by location.
number
Longitude coordinates of the corresponding area center. Used to filter territories by location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique 32-character identifier of the avoidance zone to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Filter configuration for location results.
object
Clustering configuration that determines how locations are grouped geographically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_GET_FEEDRetrieve activities from the Route4Me activity feed, with optional filters and pagination. Use to view activity history, track route changes, or monitor team member actions.

Input Parameters

integer
End of the Activity dates range (Unix timestamp).
boolean
If ‘true’, all Team Activities will be included into the search results.
integer
Limit of the queried records number.
string
Search in the ‘activity_message’ field by the corresponding query phrase.
integer
Start of the Activity dates range (Unix timestamp).
integer
Start the search from the corresponding record number.
string
Route ID associated with the corresponding Activity(s).
integer
Member ID associated with the corresponding Activity(s).
string
Filter results by Activity type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The identifier of the team member whose most recent scheduled route should be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The unique ID of the contact to retrieve heatmap data for. Required if location_id is not provided.
integer
The unique ID of the location to retrieve heatmap data for. Required if contact_id is not provided.
integer
required
Number of trailing days for the heatmap data. Valid value: 30 (other values may return validation errors).
integer
required
The metric type identifier for the heatmap data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the location type to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter by member configuration setting. Use this to retrieve specific configuration settings.
string
Filter by specific configuration key. Use this to retrieve a single configuration setting by its key name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
UUID identifier of the optimization profile to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Route Address ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Route identifier as a 32-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Set to 1 to include addresses within the territory in the response. Default is 0 (exclude addresses).
string
The unique identifier for a specific territory. If omitted, returns all territories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
required
Latitude coordinates of the device location.
number
required
Longitude coordinates of the device location.
number
Movement speed of the device (typically in mph or km/h).
number
Movement course/heading of the device in degrees (0-360).
number
Altitude/elevation of the device location.
string
ID of the route associated with this tracking data.
string
required
Unique identifier for the device (also known as ‘device_guid’).
number
Number of footsteps recorded by the device.
string
ID of the vehicle with the installed tracking device.
string
required
Application version number.
string ("android" | "android_phone" | "android_tablet" | "iphone" | "ipad")
required
Type of device submitting tracking data.
string
Timezone of the device.
string
required
Application build number.
string
Timestamp from the device when the tracking data was captured.
string
Timezone offset from UTC in seconds or hours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the sub-user to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the user whose modification history you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The requested page number. Must be at least 1.
string
Must contain a valid JSON with search_query attribute. E.g. {"search_query":"1"}
array
Order by the fields’ names with their specific order direction. E.g. [[max_volume, asc], [max_revenue, desc]]
integer
The number of vehicle capacity profiles per page.
boolean
Paginate all the data into one page only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Vehicle Capacity Profile ID. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The requested page number for pagination. Must be at least 1.
string
Must contain a valid JSON string with search_query attribute for filtering profiles. Example: ’{“search_query”:“1”}’
integer
The number of vehicle capacity profiles per page. Default is 100.
boolean
Paginate all the data into one page only. Set to true to retrieve all profiles in a single response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_LIST_LOCATION_TYPESTool to retrieve location type definitions used in the address book system. Use when categorizing addresses or locations in Route4Me.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of records to return. Must be between 1 and 300.
integer
Pagination offset for results. Use to retrieve subsequent pages of data.
string
required
Route identifier as a 32-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Defaults to 1 if not specified.
integer
Number of results to return per page. Common values: 10, 25, 50, 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
Array of member IDs to retrieve. Minimum 1 member ID required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_MERGE_ROUTESMerge destinations from multiple routes into a single target route to consolidate routes. The returned success flag alone does not independently confirm that the merge occurred.

Input Parameters

array
required
Array of route IDs to merge into the target route. These routes’ destinations will be added to the target route.
string
required
The unique ID of the target route that will receive the merged destinations from other routes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_MOVE_ROUTEMove a destination from one route to another, placing it after a specified destination on the recipient route. Use this to reorganize routes or reassign stops. The returned success flag alone does not independently confirm that the move occurred.

Input Parameters

string
required
The unique ID of the recipient route where the destination will be moved to.
integer
required
The unique ID of the destination in the recipient route, after which the moving destination will be inserted.
integer
required
The unique ID of the destination to be moved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
List of addresses to update in the optimization.
object
Route parameters for optimization.
string
required
The optimization problem ID to re-optimize.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Response format. Only ‘json’ is supported. Default: json.
boolean
If true, bypasses the cache and forces a fresh reverse geocoding request.
integer
Quality level for reverse geocoding results (1-5). Higher values provide more precise results.
boolean
If true, returns detailed reverse geocoding information.
number
required
Latitude coordinate to reverse geocode (range: -90 to 90).
number
required
Longitude coordinate to reverse geocode (range: -180 to 180).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("visited" | "departed")
required
The desired status. Use visited to mark the destination as visited, or departed to mark as departed.
string
required
The unique ID of the route containing the destination.
integer
required
The unique ID of the destination to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Rating value for the route. Must be between 1 and 5.
string
required
Route identifier as a 32-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
required
Latitude coordinate of the current location.
number
required
Longitude coordinate of the current location.
number
Speed of the vehicle in miles per hour.
string
Transaction ID for this tracking update.
number
Direction/course heading in degrees (0-360).
number
Altitude value in meters.
string
required
The route identifier to track.
integer
Member ID of the person being tracked.
string
Vehicle identifier associated with the route.
string
Application version sending the tracking data.
string
Device GUID identifier for the tracking device.
string
Type of device sending the tracking data (e.g., ‘web’, ‘android_phone’, ‘iphone’).
string
Device timestamp in ISO 8601 format or Unix timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Primary address line.
string
Secondary address line (apartment, suite, etc.).
string
Contact’s last name.
integer
required
The unique ID of the address book contact to update.
string
Contact’s first name.
number
Latitude coordinate for the address.
number
Longitude coordinate for the address.
string
ZIP or postal code.
string
City name.
integer
Service time at the location in seconds.
string
Custom name or alias for the contact.
string
Email address of the contact.
string
Group identifier for organizing contacts.
integer
First time window end in seconds from midnight (e.g., 64800 for 6:00 PM).
string
State code (e.g., NY, CA).
integer
First time window start in seconds from midnight (e.g., 28800 for 8:00 AM).
object
Custom key-value pairs for additional data.
string
Phone number of the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_UPDATE_AVOIDANCEUpdate an existing avoidance zone for route planning by territory ID. The request requires the zone’s name, color, and geographic shape and coordinates.

Input Parameters

object
required
Updated geospatial data defining the shape and coordinates of the avoidance zone.
string
required
The unique 32-character MD5 identifier of the avoidance zone to update.
string
required
Updated name for the avoidance zone.
string
required
Updated hex color code for the territory (e.g., ‘0000ff’ for blue, ‘ff0000’ for red).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the location type.
string
Description of the location type. Optional field to provide additional context about this type.
boolean
required
Whether this location type should be marked as a child type. Set to true if this type belongs under a parent type.
boolean
required
Whether this location type should be marked as a parent type. Set to true if this type can have child types.
string
required
The unique identifier for the location type to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Configuration key name to update (e.g., ‘alert_elimination’, ‘notification_template’, ‘service_provider’).
string
required
New value for the configuration setting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Custom Note Type ID to update. Use Get Note Custom Types action to retrieve available IDs.
string
required
The custom note type name. This should match the existing name of the note type being updated.
array
required
Array of custom values for the note type. These values replace the existing values for this custom note type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_UPDATE_OPTIMIZATION_PROFILEUpdate an existing optimization profile’s routing preferences, constraints, or settings by ID. A profile name is required with every update.

Input Parameters

integer
Driver ID associated with this optimization profile.
boolean
Set as default profile. When true, this profile becomes the default optimization profile.
string
Vehicle ID associated with this optimization profile.
boolean
Avoid tolls in routing. When true, routes will avoid toll roads.
integer
Maximum distance constraint for routes in the optimization profile (in miles or kilometers depending on account settings).
string
required
The name of the optimization profile.
boolean
Avoid highways in routing. When true, routes will avoid highway usage.
integer
Maximum number of stops allowed in a route for this optimization profile.
string
Optimization type for routes: ‘multi’ for multi-stop optimization, ‘single’ for single destination, or ‘off’ to disable optimization.
string
required
The unique identifier of the optimization profile to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_UPDATE_ORDER_CUSTOM_FIELDUpdate an existing order custom field by ID. Each update requires the field’s label, type, and type-specific configuration.

Input Parameters

integer
required
The unique identifier for the custom field being updated.
string
required
Updated type of the custom field (e.g., checkbox, text, dropdown).
string
required
Updated label for the custom field.
object
required
Additional metadata about the field type with configuration details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
Array of route objects to update. Each object must contain route_id and update_data fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optimization criterion for the route (e.g., Distance, Time, timeWithTraffic).
string
required
The unique identifier of the route to update. Route ID is a hex string with 32 characters.
string
Device type used for accessing the route (e.g., web, iphone, android).
string
Travel mode for the route (e.g., Driving, Walking, Bicycling, Trucking).
string
Distance measurement unit for the route. Use ‘mi’ for miles or ‘km’ for kilometers.
integer
Vehicle capacity constraint for the route.
integer
Maximum duration allowed for the route in seconds.
number
Maximum distance the vehicle can travel in miles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROUTE4ME_UPDATE_ROUTE_V4Update a route’s parameters, including its name, optimization criterion, duration constraint, or assigned team member.

Input Parameters

string
required
The ID of the route to update.
object
required
Object containing route update fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Geospatial data defining the territory shape.
string
required
The unique 32-character MD5 identifier of the territory to update.
string
Updated name for the territory.
string
Updated hex color code for the territory (e.g., ‘00ff00’ for green, ‘ff0000’ for red).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Vehicle Capacity Profile ID. The unique identifier of the profile to update.
string
Name of the vehicle capacity profile. Should be descriptive and unique.
number
Maximum volume capacity of the vehicle. Must be non-negative.
number
Maximum weight capacity of the vehicle. Must be non-negative.
number
Maximum revenue capacity of the vehicle. Must be non-negative.
integer
Maximum number of items the vehicle can carry. Must be non-negative.
string
Units for maximum volume (e.g., ‘cu ft’ for cubic feet, ‘cu m’ for cubic meters).
string
Units for maximum weight (e.g., ‘lb’ for pounds, ‘kg’ for kilograms).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not