REST API
SUPPORTFEEDBACK

[beta] Update a route template

patch
https://api.samsara.com/hub/route-templates

Update an existing route template by its unique identifier. Only the fields provided in the request body are changed.

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Write Routes under the Driver Workflow category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

The unique identifier of the route template to update.

Body Params

Request body for updating a hub route template. All fields are optional; only provided fields are changed.

string

The external identifier of the default end depot, as configured in the hub. Send an empty string to clear it.

string

The external identifier of the default start depot, as configured in the hub. Send an empty string to clear it.

string

Default start time in HH:MM format in the hub's local timezone (e.g. '08:00'). Send an empty string to clear it.

locationsByExternalIds
array of strings

Full replacement of the ordered stop list, referenced by external ID. Omit to leave stops unchanged; send an empty array to clear all stops.

locationsByExternalIds
string

The new name of the route template.

Responses

Updated 1 day ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago

Did this page help you?