---
title: "[beta] Create a ridership route setup."
method: POST
path: "/ridership/route-setups"
tags: ["Beta APIs"]
---

# \[beta\] Create a ridership route setup.

`POST /ridership/route-setups`

## Request

- Base URL: `https://api.samsara.com`
- URL: `https://api.samsara.com/ridership/route-setups`
- Auth: HTTP bearer

Create passenger assignments for an existing Routing API route. If the route already has a setup, use the update endpoint instead.

 <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select **Write Ridership** under the Ridership category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 

 **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

## Request body

- RidershipRouteSetupsCreateRidershipRouteSetupRequestBody
  - `passengers` RidershipRouteSetupPassengerInputRequestBody[], required: Passenger assignments for the route, with each passenger listed once.
    - `dropOffStopId` string: Drop-off stop task ID from the Routing API, or an external ID such as `stopKey:stop-456`. Omit to leave the drop-off stop unspecified.
    - `passengerId` string, required: The Samsara UUID of the passenger, or an external ID in `key:value` format. For example, `student:STU-001`.
    - `pickUpStopId` string: Pickup stop task ID from the Routing API, or an external ID such as `stopKey:stop-123`. Omit to leave the pickup stop unspecified.
  - `routeId` string, required: The Samsara route ID returned by the Routing API, or an external ID in `key:value` format. For example, `extRoute:WB-12`.

## Response `200`

OK response.

- RidershipRouteSetupsCreateRidershipRouteSetupResponseBody
  - `data` RidershipRouteSetupObjectResponseBody, required: A ridership route setup representing planned passenger assignments.
    - `createdAtTime` string, required: The time the route setup was created in RFC 3339 format.
    - `passengers` RidershipRouteSetupPassengerObjectResponseBody[], required: List of passenger assignments.
      - `dropOffStopId` string: Routing API stop task ID for the passenger's drop-off. Omitted when no drop-off stop is assigned.
      - `passengerId` string, required: The Samsara UUID of the passenger.
      - `pickUpStopId` string: Routing API stop task ID for the passenger's pickup. Omitted when no pickup stop is assigned.
    - `routeId` string, required: Samsara ID of the Routing API route associated with this passenger setup.
    - `updatedAtTime` string, required: The time the route setup was last updated in RFC 3339 format.

## Other responses

- `401`: Unauthorized response.
- `404`: Not Found response.
- `405`: Method Not Allowed response.
- `413`: Content Too Large response.
- `429`: Too Many Requests response.
- `500`: Internal Server Error response.
- `501`: Not Implemented response.
- `502`: Bad Gateway response.
- `503`: Service Unavailable response.
- `504`: Gateway Timeout response.
- `default`: Bad Request response.

---

[API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)