Beta APIs

[beta] Create a ridership route setup.

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.

post/ridership/route-setups

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Request body

routeIdstring required

The Samsara route ID returned by the Routing API, or an external ID in key:value format. For example, extRoute:WB-12.

Example request

{
  "passengers": [
    {
      "dropOffStopId": "790",
      "passengerId": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "pickUpStopId": "789"
    }
  ],
  "routeId": "123456"
}

Response

OK response.

Example response

{
  "data": {
    "createdAtTime": "2024-11-15T10:00:00Z",
    "passengers": [
      {
        "dropOffStopId": "790",
        "passengerId": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "pickUpStopId": "789"
      }
    ],
    "routeId": "123456",
    "updatedAtTime": "2024-11-15T10:30:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.