SAsamsara
Maintenance

Update a defect

Updates a given defect. Can be used to resolve a defect by marking its isResolved field to true.

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.

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

patch/fleet/defects/{id}

Request

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

Path parameters

idstring required

ID of the defect.

Request body

isResolvedboolean

Resolves the defect. Must be true.

mechanicNotesstring

The mechanics notes on the defect.

resolvedAtTimestring

Time when defect was resolved. Defaults to now if not provided. UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.

Example request

{
  "mechanicNotes": "Extremely large oddly shaped hole in passenger side window.",
  "resolvedAtTime": "2020-01-27T07:06:25Z",
  "resolvedBy": {
    "id": "11",
    "type": "mechanic"
  }
}

Response

Return the modified defect entity

Example response

{
  "data": {
    "comment": "Air Compressor not working",
    "createdAtTime": "2020-01-27T07:06:25Z",
    "defectType": "Air Compressor",
    "id": "18",
    "isResolved": true,
    "mechanicNotes": "Extremely large oddly shaped hole in passenger side window.",
    "mechanicNotesUpdatedAtTime": "2020-01-27T07:06:25Z",
    "resolvedAtTime": "2020-01-27T07:06:25Z",
    "resolvedBy": {
      "id": "11",
      "name": "Christopher 'The Handyman' Zhen"
    },
    "trailer": {
      "id": "123456789",
      "name": "Midwest Trailer #5"
    },
    "vehicle": {
      "ExternalIds": {
        "maintenanceId": "250020",
        "payrollId": "ABFS18600"
      },
      "id": "123456789",
      "name": "Midwest Truck #4"
    }
  }
}

Changes

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