REST API
SUPPORTFEEDBACK

Delete a route

delete
https://api.samsara.com/v1/fleet/dispatch/routes/
This endpoint is still on our legacy API.

Delete a dispatch route and its associated jobs.

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.

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

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

ID of the route. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: key:value. For example, payrollId:ABFS18600

Body Params
boolean

This is only for a recurring route. If set to true, delete all following runs of the route. If set to false, only delete the current route.

Responses
200

Successfully deleted the dispatch route. No response body is returned.

Updated 10 days ago

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 10 days ago