[beta] Update a ridership passenger.

put

https://api.samsara.com/ridership/passengers

Update a passenger by Samsara UUID or external ID, such as student:STU-001. The response includes the passenger's external IDs.

Both first and last name are required. Include the values you want to keep:

Omitted classification, special instructions, identifiers, and external IDs are cleared.
Omitted tags are kept. Send tagIds: [] to remove them.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Ridership under the Ridership 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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

required

Samsara UUID of the passenger, or an external ID in key:value format, such as student:STU-001.

Body Params

classification

string

enum

Passenger grade level: pk1–pk4 are pre-kindergarten categories, k is kindergarten, and grade1–grade12 are grades 1–12. Use unknown when the grade level is not known. Valid values: unknown, pk1, pk2, pk3, pk4, k, grade1, grade2, grade3, grade4, grade5, grade6, grade7, grade8, grade9, grade10, grade11, grade12

externalIds

object

Customer-defined IDs that link this passenger to another system, such as {"student": "STU-001"}.

firstName

string

required

Passenger's first name. Maximum 100 characters.

identifiers

array of objects

Identifiers used to recognize the passenger, such as RFID card values. Maximum 10.

identifiers

lastName

string

required

Passenger's last name. Maximum 100 characters.

specialInstructions

object

Special handling flags for the passenger. Omitted flags default to false.

tagIds

array of strings

Replaces the passenger's tags with up to 10 Samsara tag IDs; external IDs are not supported here. Omit to keep existing tags, or send [] to remove all tags.

tagIds

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK response.

401Unauthorized response.

404Not Found response.

405Method Not Allowed response.

413Content Too Large response.

429Too Many Requests response.

500Internal Server Error response.

501Not Implemented response.

502Bad Gateway response.

503Service Unavailable response.

504Gateway Timeout response.

defaultBad Request response.