SAsamsara
Beta APIs

[beta] Update a ridership passenger.

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.

<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.

put/ridership/passengers

Request

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

Query parameters

idstring required

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

Request body

classification'unknown' | 'pk1' | 'pk2' | 'pk3' | 'pk4' | 'k' | 'grade1' | 'grade2' | 'grade3' | 'grade4' | 'grade5' | 'grade6' | 'grade7' | 'grade8' | 'grade9' | 'grade10' | 'grade11' | 'grade12'

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

externalIdsobject

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

firstNamestring required

Passenger's first name. Maximum 100 characters.

lastNamestring required

Passenger's last name. Maximum 100 characters.

tagIdsstring[]

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. If your API token is restricted to certain tags, tags outside its scope are kept and can't be added.

Example request

{
  "classification": "grade5",
  "firstName": "John",
  "identifiers": [
    {
      "status": "active",
      "type": "rfid",
      "value": "0418A2BC93"
    }
  ],
  "lastName": "Doe",
  "tagIds": [
    "5678",
    "9012"
  ]
}

Response

OK response.

Example response

{
  "data": {
    "classification": "grade5",
    "createdAtTime": "2024-11-15T10:00:00Z",
    "firstName": "John",
    "id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "identifiers": [
      {
        "id": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
        "status": "active",
        "type": "rfid",
        "value": "0418A2BC93"
      }
    ],
    "isActive": true,
    "lastName": "Doe",
    "tagIds": [
      "5678",
      "9012"
    ],
    "updatedAtTime": "2024-11-15T10:30:00Z"
  }
}

Changes

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