SAsamsara
Maintenance

Update a warranty

Updates an existing warranty for the organization.

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

To use this endpoint, select Write Warranties under the Work Orders 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.

patch/maintenance/warranties

Request

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

Query parameters

idstring required

Unique identifier for the Warranty record.

Request body

descriptionstring

Description of the warranty.

durationDaysinteger

Warranty length in days. Mutually exclusive with duration in months.

durationMonthsinteger

Warranty length in months. Mutually exclusive with duration in days.

engineDurationHoursinteger

Warranty length by engine hours since the warranty start.

namestring

Name of the warranty.

odometerDistanceMetersinteger

Warranty length by distance travelled since the warranty start. Measured in meters.

vendorIdstring

ID of the vendor that provides this warranty.

warrantyType'unknown' | 'manufacturer' | 'extended' | 'other'

Type of warranty, for example manufacturer, extended, other, or unknown. Valid values: unknown, manufacturer, extended, other

Example request

{
  "baseCoverage": {
    "description": "12345",
    "durationDays": 12345,
    "durationMonths": 12345,
    "engineDurationHours": 12345,
    "exclusions": [
      {
        "id": "12345",
        "itemType": "unknown",
        "vmrsCode": "12345"
      }
    ],
    "inclusions": [
      {
        "id": "12345",
        "itemType": "unknown",
        "vmrsCode": "12345"
      }
    ],
    "isOdometerDistanceUnlimited": true,
    "name": "12345",
    "notes": "12345",
    "odometerDistanceMeters": 12345,
    "startEngineHours": 12345,
    "startOdometerMeters": 12345,
    "startTime": "2019-06-13T19:08:25Z"
  },
  "coverages": [
    {
      "description": "12345",
      "durationDays": 12345,
      "durationMonths": 12345,
      "engineDurationHours": 12345,
      "exclusions": [
        {
          "id": "12345",
          "itemType": "unknown",
          "vmrsCode": "12345"
        }
      ],
      "inclusions": [
        {
          "id": "12345",
          "itemType": "unknown",
          "vmrsCode": "12345"
        }
      ],
      "isOdometerDistanceUnlimited": true,
      "name": "12345",
      "notes": "12345",
      "odometerDistanceMeters": 12345,
      "startEngineHours": 12345,
      "startOdometerMeters": 12345,
      "startTime": "2019-06-13T19:08:25Z"
    }
  ],
  "description": "12345",
  "durationDays": 12345,
  "durationMonths": 12345,
  "engineDurationHours": 12345,
  "externalIds": [
    {
      "key": "12345",
      "value": "12345"
    }
  ],
  "name": "12345",
  "odometerDistanceMeters": 12345,
  "vendorId": "281474976710656",
  "warrantyType": "unknown"
}

Response

OK response.

Example response

{
  "data": {
    "baseCoverage": {
      "description": "12345",
      "durationDays": 12345,
      "durationMonths": 12345,
      "engineDurationHours": 12345,
      "exclusions": [
        {
          "id": "12345",
          "itemType": "unknown",
          "vmrsCode": "12345"
        }
      ],
      "inclusions": [
        {
          "id": "12345",
          "itemType": "unknown",
          "vmrsCode": "12345"
        }
      ],
      "isOdometerDistanceUnlimited": true,
      "name": "12345",
      "notes": "12345",
      "odometerDistanceMeters": 12345,
      "startEngineHours": 12345,
      "startOdometerMeters": 12345,
      "startTime": "2019-06-13T19:08:25Z"
    },
    "coverages": [
      {
        "description": "12345",
        "durationDays": 12345,
        "durationMonths": 12345,
        "engineDurationHours": 12345,
        "exclusions": [
          {
            "id": "12345",
            "itemType": "unknown",
            "vmrsCode": "12345"
          }
        ],
        "inclusions": [
          {
            "id": "12345",
            "itemType": "unknown",
            "vmrsCode": "12345"
          }
        ],
        "isOdometerDistanceUnlimited": true,
        "name": "12345",
        "notes": "12345",
        "odometerDistanceMeters": 12345,
        "startEngineHours": 12345,
        "startOdometerMeters": 12345,
        "startTime": "2019-06-13T19:08:25Z"
      }
    ],
    "createdAtTime": "2019-06-13T19:08:25Z",
    "description": "12345",
    "durationDays": 12345,
    "durationMonths": 12345,
    "engineDurationHours": 12345,
    "externalIds": [
      {
        "key": "12345",
        "value": "12345"
      }
    ],
    "id": "12345",
    "name": "12345",
    "odometerDistanceMeters": 12345,
    "updatedAtTime": "2019-06-13T19:08:25Z",
    "vendor": {
      "id": "281474976710656"
    },
    "warrantyType": "unknown"
  }
}

Changes

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